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

Remove leading '$' from command snippets in README.md #105

Open
bnsmcx opened this issue Jul 18, 2023 · 0 comments
Open

Remove leading '$' from command snippets in README.md #105

bnsmcx opened this issue Jul 18, 2023 · 0 comments

Comments

@bnsmcx
Copy link

bnsmcx commented Jul 18, 2023

The documentation is straightforward and easy to follow and the 'copy' button is useful for quickly getting set up. However, while the leading $ does make it clear to the reader that snippet represents a CLI command, it also makes it an invalid command. The user has to go back and remove this character or else the command fails:

image

I can make the changes and link the pull request if the maintainers think this is a worthwhile tweak.

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

No branches or pull requests

1 participant