Repository navigation
docs: cut the README down to install and one example - #70
Merged
Merged
Conversation
Everything after the example (package tables, limits, the stack table, doc link lists) moves out of the README; the docs carry the details and the gotchas. What stays is the header, the install lines, one example with a short explanation, and the licence.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
The trim went further than intended: the 'Where this fits' table and the Contributing pointer stay in every README. Only the limits, package and documentation-link sections stay out.
Contributor
|
This PR is included in version 1.8.0 |
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
1 participant
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.
Everything after the example (package tables, limits, the stack table, doc link lists) moves out of the README; the docs carry the details and the gotchas. What stays is the header, the install lines, one example with a short explanation, and the licence.