cherrypick edits to README in 4bf830 by @frinkelpi #86
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
- Updated markdown to have well formed lists - Updated headers - Integrated edits by @frinkelpi from #59 to reword instructions
|
I'm planning on breaking out the README into a Wiki, so I'm closing this for now because it's mostly small formatting changes. |
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.
Hey there,
Finally got some time to play with the repo. I'm starting out by integrating work by @frinkelpi in #59 to clean up the documentation and code. Sending this small PR to tweak the README. Going to follow this up with some enhancements to the code, and then tackle the suggested work in #39.
Details: