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

Add missing options to the readme. #63

Merged
merged 1 commit into from
Apr 9, 2021
Merged

Add missing options to the readme. #63

merged 1 commit into from
Apr 9, 2021

Conversation

rhoboat
Copy link
Contributor

@rhoboat rhoboat commented Mar 30, 2021

No description provided.

Copy link
Contributor

@bwhaley bwhaley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Copy link
Member

@brikis98 brikis98 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoops, not sure how we missed adding these to the docs. Thx for fixing this.

@@ -51,7 +51,10 @@ Option | Required | Description
`--binary-sha512-checksum` | No | The SHA512 checksum of the binary specified by `--binary-name`. Should be exactly 128 characters..
`--module-param` | No | A key-value pair of the format `key=value` you wish to pass to the module as a parameter. May be used multiple times. <br>Note: a `--` will automatically be appended to the `key` when your module is invoked<br>See the documentation for each module to find out what parameters it accepts.
`--download-dir` | No | The directory to which the module will be downloaded and from which it will be installed.
`--branch ` | No | Download the latest commit from this branch in --repo. This is an alternative to --tag,<br>and is used only for testing. This value is exposed to module install scripts as GRUNTWORK_INSTALL_BRANCH.
`--binary-install-dir` | No | The directory to which the binary will be installed. Only applies to binaries (not modules). Default: $DEFAULT_BIN_DIR"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This $DEFAULT_BIN_DIR doesn't seem to be rendering correctly in Markdown 😁

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops! Good catch.

@rhoboat rhoboat merged commit 9783f9f into master Apr 9, 2021
@rhoboat rhoboat deleted the rho/readme branch April 9, 2021 19:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants