docs: rewrite README, add example test + improve comments #30
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
jamietanna
force-pushed
the
docs/rewrite
branch
from
aca5d03 to
d24793e
Compare
As it could do with more information.
jamietanna
force-pushed
the
docs/rewrite
branch
2 times, most recently
from
7089243 to
834ae33
Compare
added 2 commits
April 24, 2025 10:19
As a means to provide a full example of usage, we can use a testable example.
jamietanna
force-pushed
the
docs/rewrite
branch
from
834ae33 to
50f73a8
Compare
jamietanna
changed the title
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.
No description provided.