From 0cb1ceb8f38877dc92cc3016eb74e06888f99232 Mon Sep 17 00:00:00 2001 From: Manish Kumar Date: Fri, 7 Aug 2026 22:13:49 -0500 Subject: [PATCH] docs: sync README with the @omnibioai package rename, fix broken tokens.css path Same issue as omnibioai-design-tokens: package.json was renamed to @omnibioai/ui, but README.md's 26 @man4ish/* references (title, install instructions, every single component's import example, Related Repos) were never updated. One fix beyond a straight scope rename: the design-tokens import example said `import '@omnibioai/design-tokens/dist/tokens.css'` -- that package has no dist/ directory (confirmed in its own package.json: files/exports only expose ./tokens.css at the package root), so this subpath would fail to resolve regardless of scope. Fixed to the real path. Also: the Related Repos table's omnibioai entry pointed at github.com/man4ish/omnibioai and said "200+ plugin" -- that repo's real name is omnibioai-workbench (git remote -v there confirms; the local omnibioai/ directory name differs from the GitHub repo name), and its own README was corrected to 231 enabled plugins earlier this session. Fixed both. Component list, "50+ unit tests" claim, and License (MIT) were all independently verified accurate and left unchanged. Co-Authored-By: Claude Sonnet 5 --- README.md | 60 +++++++++++++++++++++++++++---------------------------- 1 file changed, 30 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 15344f3..77f1e99 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ -# @man4ish/ui +# @omnibioai/ui -Shared React component library for the [OmniBioAI](https://github.com/man4ish/omnibioai-studio) platform. Provides `Button`, `Badge`, `Card`, `Input`, `StatusDot`, `Spinner`, `Table`, `Tabs`, `ProgressBar`, `Tooltip`, and `Select` components built on unified design tokens with zero hardcoded colors. +Shared React component library for the [OmniBioAI](https://github.com/OmniBioAI/omnibioai-studio) platform. Provides `Button`, `Badge`, `Card`, `Input`, `StatusDot`, `Spinner`, `Table`, `Tabs`, `ProgressBar`, `Tooltip`, and `Select` components built on unified design tokens with zero hardcoded colors. --- ## Overview - **TypeScript-first** — full type definitions shipped with the package -- **Design-token driven** — all colors, spacing, and radii come from `@man4ish/design-tokens`; no hardcoded hex values anywhere in the library +- **Design-token driven** — all colors, spacing, and radii come from `@omnibioai/design-tokens`; no hardcoded hex values anywhere in the library - **Tree-shakeable** — built as ES module + CJS with Vite library mode; only import what you use - **React 18+ peer dep** — works with any React 18+ project including the OmniBioAI Electron app and any downstream consumer - **Fully tested** — 50+ unit tests with Vitest + React Testing Library @@ -19,14 +19,14 @@ Shared React component library for the [OmniBioAI](https://github.com/man4ish/om ## Installation -This package is published to the GitHub Packages registry under `@man4ish`. +This package is published to the GitHub Packages registry under `@omnibioai`. ### 1. Authenticate with GitHub Packages Create or update `.npmrc` in your project root: ``` -@man4ish:registry=https://npm.pkg.github.com +@omnibioai:registry=https://npm.pkg.github.com //npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN ``` @@ -35,17 +35,17 @@ Your token needs `read:packages` scope. Generate one at GitHub → Settings → ### 2. Install the package ```bash -npm install @man4ish/ui @man4ish/design-tokens +npm install @omnibioai/ui @omnibioai/design-tokens ``` -`@man4ish/design-tokens` is a required peer — it provides the CSS custom properties that all components reference. +`@omnibioai/design-tokens` is a required peer — it provides the CSS custom properties that all components reference. ### 3. Load design tokens In your app entry point, import the token stylesheet once: ```ts -import '@man4ish/design-tokens/dist/tokens.css'; +import '@omnibioai/design-tokens/tokens.css'; ``` All components will pick up the correct colors, spacing, and radii automatically from there. @@ -57,7 +57,7 @@ All components will pick up the correct colors, spacing, and radii automatically ### `Button` ```tsx -import { Button } from '@man4ish/ui'; +import { Button } from '@omnibioai/ui';