feat: update README #9
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
misscoded
commented
Jan 11, 2024
zimeg
approved these changes
Jan 11, 2024
zimeg
reviewed
Jan 11, 2024
zimeg
reviewed
Jan 11, 2024
WilliamBergamin
approved these changes
Jan 11, 2024
There was a problem hiding this comment.
I went through the comments once resolved this looks good to me 💯
This will resolve #6
filmaj
approved these changes
Jan 11, 2024
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
Updates README to reflect how this library is intended to be used. Resolves #6.
Requirements
./scripts/install_and_run_tests.shafter making the changes.