docs: update README with improved TOON description and installation i…#7
Closed
smortezah wants to merge 1 commit intotoon-format:mainfrom
Closed
docs: update README with improved TOON description and installation i…#7smortezah wants to merge 1 commit intotoon-format:mainfrom
smortezah wants to merge 1 commit intotoon-format:mainfrom
Conversation
Contributor
|
I love these small, incremental README fixes! Could you please re-open once the repo is ready? The first version is currently in development. Let's wait until #6 is resolved and the team has formed. Please re-open later. Thank you for your understanding! |
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
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.
This pull request updates the
README.mdto clarify the purpose and usage of the TOON format, improves onboarding instructions, and reorganizes documentation for better readability. The most important changes include clearer explanations of TOON, a new installation section, improved example formatting, and a more logical structure for resources and usage.Documentation and explanation improvements:
Onboarding and installation:
toon-formatpackage usinguv.Example formatting:
toonfor the TOON example to improve syntax highlighting and readability.Usage and resources organization:
data, added an assertion for round-trip encoding/decoding, and moved the "Resources" section to follow usage instructions for better flow.Resource links: