Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README to illustrate clearer usage of the -a/-e options #26

Closed
david-homley opened this issue Sep 28, 2020 · 2 comments
Closed
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@david-homley
Copy link

The README.md is not clear on how to use the -a/-e options, e.g. there are no clear examples documenting their expected usage.

The 'help' message could also be a bit more descriptive and clear in stating the expected format of the supplied arguments as well.

@al-jeyapal
Copy link
Collaborator

Specifically, you need to supply values in the format HELLO=/path/to/hello. Our help text should just explain that better. Especially in relation to -a since the key (left hand side) will be used as an environment variable name, and needs to conform to certain conventions (cannot contain hyphens, etc)

@thomas-anderson-bsl
Copy link
Contributor

Resolved by #45

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants