README: Usage before installation #144
Merged
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 #144 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 6 6
Lines 546 546
Branches 74 74
=========================================
Hits 546 546 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
Can you add a table of contents before Usage? |
|
Something like this? https://github.com/ofek/pypinfo/blob/readme-usage-first/README.rst |
|
Yup! |
ofek
approved these changes
Nov 30, 2022
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.
I think it's more useful for potential users, and existing users, to see the examples in the usage section first, before the installation screenshots.