Simplify the README - #2
Open
lxsmnsyc wants to merge 1 commit into
Open
Conversation
The README carried a lot of prose that explained internals rather than usage. This trims it to what a reader needs, without dropping any documented API. - Remove every em-dash. Each one became a period and a new sentence, or a list item. - Turn multi-point paragraphs into lists. This covers what a target object accepts, what a component wrapped by `Motion.create` must do, and what the Playwright suite covers that jsdom cannot. - Cut the rationale that does not change what a reader writes. The reduced motion justification, the FLIP and projection detail, and the frame loop reasoning behind motion values are each one sentence now. - Fold the Introduction heading into a single line under the tagline. - Replace literary phrasing with plain wording. - Put the commands first in the Testing section and the port caveat last. - Document `pnpm run storybook` in Examples. Storybook came back with the last upstream sync but the section only mentioned the playground. Word count drops from 4047 to 3412. All 25 headings still resolve and no anchor is broken. Co-Authored-By: Claude Opus 5 <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.
The README carried a lot of prose that explained internals rather than usage. This trims it to what a reader needs, without dropping any documented API.
Motion.createmust do, and what the Playwright suite covers that jsdom cannot.pnpm run storybookin Examples. Storybook came back with the last upstream sync but the section only mentioned the playground.Word count drops from 4047 to 3412. All 25 headings still resolve and no anchor is broken.