Updated and cleaner version of the README.md #67
Merged
Conversation
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
- Removed info that can be found within the docs - Added in GitHub Badges for CI, PyPi, Coveralls Coverage and Docs Status
Closed
jimboid
approved these changes
Mar 19, 2025
Member
jimboid
left a comment
jimboid
left a comment
There was a problem hiding this comment.
Looks great. Minimal with mainly pointers to proper sources for docs etc.
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.
Summary
This PR simplifies the
README.mddocument so that it is more streamlined and contains only the information that is relevant, within the GitHub page. All other information can be found within the docs.Changes
README.mdFile: :Impact