docs: fix and expand README - #48
Merged
Merged
Conversation
Correct wrong API references in the README (ValueInt64/ValueFloat64 instead of the non-existent GetInt64/GetFloat64, valid Go for parser init, fmt.Printf), align every example with real parser output, and document the previously undocumented stream/token API. Add a Stream API reference, installation and table-of-contents sections. Also record the prose line-wrapping convention in AGENTS.md: one sentence per line, no mid-sentence hard wraps. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Summary
Overhaul of
readme.mdafter verifying every example against the actual code (token.go,stream.go,tokenizer.go) and running the doubtful ones throughgo test.Fixes (things that were wrong)
stream.GetInt64()/token.GetFloat64()→ValueInt64()/ValueFloat64(); package-leveltokenizer.ParseString(...)→parser.ParseString(...).var parser := tokenizer.New()→parser := tokenizer.New().or) claimed== "and"; fixed alignment and switched string comparisons toValueUnescapedString().fmt.Printwith%d→fmt.Printf(%d/%g)."One"for inputone!→"one".\"actually unescapes to".Improvements
AllowNumberUnderscore(), the longest-match rule,Close(), and the "don't store*Token" caveat.AGENTS.md
🤖 Generated with Claude Code