Add documentation to the Readme file #293
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
I added the main part of the documentation to the Readme file, because it's easier to read directly from the repository, and it's a bit tedious to have to go to another page to learn how to run it. This change improves the developer experience with this library.
|
Hey, we have a README.rst file. I think GitHub will be confused between the rst and MD file. Please stick to the rst file. |
catalincoroeanu
suggested changes
Jan 22, 2021
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 added the main part of the documentation to the Readme file, because it's easier to read directly from the repository, and it's a bit tedious to have to go to another page to learn how to run it. This change improves the developer experience with this library.