Rename package to react-split-flap-display and refresh README intro#4
Merged
Conversation
Rename the package from react-split-flap to react-split-flap-display (the npm name react-split-flap is taken by akira02's separate project), updating package.json, README install/import examples, the demo repo URL and storage key, and the naming-collision note in the comparison doc. Rewrite the README introduction to orient a first-time reader: lead with what a split-flap display is and a runnable example instead of the project's origin story, scope the 60fps claim to the canvas/WebGL paths, and document the previously-undocumented `alphabet` prop. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Entire-Checkpoint: 3562ac11e492
There was a problem hiding this comment.
Pull request overview
Renames the published npm package to react-split-flap-display to avoid a naming collision, and refreshes the README introduction/docs to be more newcomer-friendly (including documenting the alphabet prop).
Changes:
- Rename the package from
react-split-flaptoreact-split-flap-displayand update install/import examples. - Rewrite the README intro and add a new
Alphabetsection documentingalphabet/DEFAULT_ALPHABET. - Update demo repo URL/localStorage key and refresh the naming-collision note in
docs/comparison-akira02.md.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Updates package name references, rewrites intro, and adds alphabet documentation. |
| package.json | Changes published package name to react-split-flap-display. |
| docs/comparison-akira02.md | Updates naming-collision explanation to reflect the new package name. |
| demo/main.tsx | Updates repo link text/URL and demo localStorage key to the new name. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+108
to
+110
| give, so it also sets the sequence of characters seen during a flip. A target | ||
| character that is not in the alphabet renders as the pad character (a blank). | ||
| Set `alphabet` at the top level to apply it to every row, or per row in a row |
Owner
Author
There was a problem hiding this comment.
Fixed in 7feaa9d — reworded to "the pad character (padChar, a blank by default)" so it no longer implies the pad is always blank.
- Alphabet section: a non-alphabet character renders as `padChar` (blank by default), not always a blank — padChar is configurable. - Revert the demo REPO_URL/label to the current `ashtom/react-split-flap` slug so the link works now and after an eventual repo rename (GitHub redirects the old slug). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Entire-Checkpoint: 053f3133659f
Comment on lines
+58
to
+60
| declares `name: "react-split-flap"`). This repo originally shared that name, so | ||
| to avoid the collision it publishes as `react-split-flap-display`, signalling the | ||
| multi-row board / multi-renderer angle. Other options considered: |
Owner
Author
There was a problem hiding this comment.
Fixed — the note now says the repo "is named react-split-flap-display" rather than "publishes as" (it's still unpublished), and the status row is bumped from the stale 0.1.0 to 0.2.0 to match package.json.
The naming-collision note no longer claims the package "publishes as" the new name (it is unpublished); it now says it "is named". Also bump the status row from the stale 0.1.0 to 0.2.0 to match package.json. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Entire-Checkpoint: cd669eb2b23a
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
react-split-flaptoreact-split-flap-display. The npm namereact-split-flapis taken byakira02's separate project, so this avoids the collision. Updatespackage.json, the README install/import examples, the demo repo URL andlocalStoragekey, and the naming-collision note indocs/comparison-akira02.md.alphabetprop in a new section.References to the third-party
akira02/react-split-flapare intentionally left unchanged.Notes
The GitHub repo itself is still named
react-split-flap; renaming it to match will make the demo's newREPO_URLresolve (GitHub auto-redirects the old slug).🤖 Generated with Claude Code