Add Standard-readme #11
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This might be a bit premature - right now, it is a specification and a standard-readme yeoman generator. Plans are in the works right now to make a generator that stands alone without needing to install and run yeoman as a dep, as well as a linter using remark. The current spec, however, is still useful as a reference doc at the moment for remembering what sections should be in a good readme.
|
Update: There's now a stand alone generator. |
|
Hey @maxogden - any chance you could let me know how to improve this? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This might be a bit premature - right now, it is a specification and a standard-readme yeoman generator. Plans are in the works right now to make a generator that stands alone without needing to install and run yeoman as a dep, as well as a linter using remark. The current spec, however, is still useful as a reference doc at the moment for remembering what sections should be in a good readme.