docs: expand readme with more examples #14
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
Signed-off-by: Eric Dobroveanu <[email protected]>
Crazyglue
force-pushed
the
docs/expand-readme
branch
from
d2d11eb to
2dee078
Compare
tarilabs
reviewed
Feb 13, 2025
There was a problem hiding this comment.
/lgtm
thanks a lot @Crazyglue with some optional comments
I think eventually we should use a test "pinning" this tutorial, but right now we're moving fast and breaking things :)
Co-authored-by: Matteo Mortari <[email protected]> Signed-off-by: Eric Dobroveanu <[email protected]>
Crazyglue
force-pushed
the
docs/expand-readme
branch
from
1ee0598 to
869bbf0
Compare
Not a problem, just wanted to to update this to explain the scope of the project and to get it straight (for me) on how to use the package (as-is) |
tarilabs
approved these changes
Feb 13, 2025
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.
It wasn't always clear to me how to use this tool based on the readme, so I have cleaned it up a little bit and also expanded it to show a python example