Skip to content

Add a USAGE.md file #48

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

Closed
thinkingserious opened this issue Oct 27, 2017 · 0 comments
Closed

Add a USAGE.md file #48

thinkingserious opened this issue Oct 27, 2017 · 0 comments
Labels
difficulty: easy fix is easy in difficulty

Comments

@thinkingserious
Copy link
Contributor

Usage files are really nice when they exist in a repo, because it makes it really obvious where to look for information about how to use this tool. It can be frustrating when you expect this file to be there and it's not.
Please add a USAGE.md file, you can see an example of this
here

Please make sure you modify the file for this repo (hint: Most of this information should be in the README file)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty: easy fix is easy in difficulty
Projects
None yet
Development

No branches or pull requests

1 participant