Improved README - #34
Merged
Merged
Conversation
This was referenced Feb 3, 2016
Open
Contributor
|
Definitely an improvement with the README. Could always be a few more examples to make things easier to understand. I found the guidance I needed by looking at the tests, but for most people tests are things that the developer uses to validate, not so much the user of the library. I would suggest having a github wiki or something that just took your test cases and displayed them as examples. In time they could be broken down and explained. |
This was referenced Feb 3, 2016
thunderer
force-pushed
the
better-docs
branch
from
February 5, 2016 18:36
48a5497 to
b47d706
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Available here: https://github.com/thunderer/Shortcode/blob/better-docs/README.md .