README,doc: Move examples to a more promiment place #116
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
Codecov Report
@@ Coverage Diff @@
## master #116 +/- ##
=======================================
Coverage 97.87% 97.87%
=======================================
Files 27 27
Lines 1648 1648
=======================================
Hits 1613 1613
Misses 35 35Continue to review full report at Codecov.
|
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.
The
READMEfile has been significantly overhauled in #50 and #114. However, the order of the sections might not be intuitive enough for new users and visitors. Move the examples subsection to a more prominent place in the beginning of theREADMEto motivate example use cases and connect them to the philosophy of the library. This strengthens the overall motivation part and reduces the focus on the technical compilation part.