-
-
Notifications
You must be signed in to change notification settings - Fork 34
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
Update README.md files #31
Comments
rayrfan
pushed a commit
that referenced
this issue
Oct 16, 2017
rayrfan
pushed a commit
that referenced
this issue
Oct 16, 2017
rayrfan
pushed a commit
that referenced
this issue
Oct 28, 2017
rayrfan
pushed a commit
that referenced
this issue
Nov 6, 2017
rayrfan
pushed a commit
that referenced
this issue
Nov 20, 2017
rayrfan
pushed a commit
that referenced
this issue
Nov 20, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Writing a good readme.md is complex but necessary
Do the following
Readmes I like
A helpful checklist to gauge how your README is coming along:
One-liner explaining the purpose of the module
Necessary background context & links
Potentially unfamiliar terms link to informative sources
Clear, runnable example of usage
Installation instructions
Extensive API documentation
Performs cognitive funneling
Caveats and limitations mentioned up-front
Doesn't rely on images to relay critical information
License
The text was updated successfully, but these errors were encountered: