Skip to content

docs(readme): lead with what it is, where it fits and how to upgrade - #72

Merged
TheGreatAxios merged 1 commit into
cl-9077-react-ui-drop-prepare-script-used-only-for-git-installsfrom
polish-react-ui-readme
Sep 27, 2026
Merged

TheGreatAxios merged 1 commit into
cl-9077-react-ui-drop-prepare-script-used-only-for-git-installsfrom
polish-react-ui-readme

Conversation

@TheGreatAxios

@TheGreatAxios TheGreatAxios commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Stacked on #60.

  • The README now follows the Corbits package README standard. It opens with what the package is, the Corbits UI bucket and where it fits next to Interchange, then covers install with peers, a quickstart, a usage and reference section (theming and component tables, with optional-peer rows marked), wiring to the hub through @intx/hub-client, and an "Upgrading from 0.1" section listing the 0.2.0 breaks: git installs, optional peers and subpath-only modules, internal helpers, "use client", removed modules and the OS-following theme.
  • The development commands and the how-it-works paragraph move to CONTRIBUTING.md.

Verification

Both tsx blocks typecheck against the packed tarball. prettier --check README.md is clean. typecheck, lint, dep-guard, bun test and bun run build pass.

Closes CL-9354

@TheGreatAxios
TheGreatAxios force-pushed the polish-react-ui-readme branch 2 times, most recently from 3c12093 to ce16f22 Compare September 26, 2026 01:32
@TheGreatAxios TheGreatAxios changed the title Polish the README for npm docs(readme): lead with what it is, where it fits and how to upgrade Sep 26, 2026
@TheGreatAxios
TheGreatAxios added this pull request to stack #74 September 26, 2026 01:57
Moves the development notes and the how-it-works paragraph to
CONTRIBUTING.md so the README covers install, quickstart, reference,
Interchange wiring and the 0.1 upgrade path. Every tsx block
typechecks against the packed build.
@TheGreatAxios
TheGreatAxios merged commit f9831fa into main Sep 27, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant