docs: cut the README back to what a user needs - #505
Merged
Merged
Conversation
Drops the paragraph explaining why there is no bare React Native example. The absence does not need defending to someone who never knew there were two, and the archived repository points at the Expo one already. Drops the NPM_TOKEN setup from the Releasing section. It is maintainer configuration, done once, and it does not belong in a file people read to find out how to use the library. The rest is a tone pass. The sections added over the last few days argued their own design decisions at the reader: why two node types exist, why nesting lists is the arrangement React Native warns against, why levels start at 1 rather than 0, why the merge order for listProps is what it is. That reasoning belongs in the CHANGELOG, where it is already written down, and in the commits that made the decisions. A README should say what the thing does and how to use it. 48 lines in, 91 out. No documented behaviour changed.
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.
The bare example
Gone, not reworded. The paragraph explained why there is no bare React Native example — which only makes sense to someone who knew there used to be two. The archived repository already points at the Expo one, so anyone arriving from an old link still lands somewhere useful.
NPM_TOKEN
Gone from Releasing. It is maintainer configuration, done once, and it does not belong in a file people read to find out how to use the library. What is left says how a release happens and nothing about how to set one up.
Tone pass on the rest
The sections I added over the last few days argued their own design decisions at the reader:
That reasoning is real, but it belongs in the CHANGELOG, where it is already written, and in the commits that made the decisions. Someone reading the README wants to know that levels start at 1 and how to get a flush edge — three lines, not three paragraphs.
Same treatment for Performance, Types, Node identity, Reaching the list and Using another list: kept the facts and the tables, cut the justification and the "so X, which is what lets Y" chains.
Net
48 lines in, 91 out. No documented behaviour changed, no props or types removed from the reference, every table kept.
🤖 Generated with Claude Code