@solibo/solibo-ui 0.3.26 → 0.3.28

package/README.md

@@ -1,6 +1,38 @@
-## Development Guide 👩‍💻
+# @solibo/solibo-ui
 
-There is no try, only do.
+A React 19 + TypeScript component library built with Vite. Ships typed, tree‑shakeable components, CSS Modules styling, and Storybook docs.
+
+- Package: `@solibo/solibo-ui`
+- Node: 22
+- Package manager: pnpm
+
+## Installation
+
+```bash
+pnpm add @solibo/solibo-ui
+# peer deps (if not present)
+pnpm add react@^19 react-dom@^19 -D
+```
+
+## Quick usage
+
+```tsx
+import { Figure } from '@solibo/solibo-ui';
+
+export const Example = () => (
+  <Figure
+    label='Example'
+    offset='left'
+  >
+    <img
+      src='/path/to/image.jpg'
+      alt=''
+    />
+  </Figure>
+);
+```
+
+## Development
 
 ### Quickstart
 
@@ -9,17 +41,30 @@ pnpm install
 pnpm storybook
 ```
 
-### Component Generator
+### Component generator
 
 ```bash
 ./generate <name>
 ```
 
-### Tooling
+### Scripts
 
 ```bash
-pnpm dev
-pnpm format
-pnpm lint
-pnpm test
+pnpm dev         # vite build --watch (library build)
+pnpm build       # type-check + library build
+pnpm test        # vitest (UI mode by default via script)
+pnpm lint        # eslint
+pnpm stylelint   # stylelint for CSS modules
+pnpm format      # prettier check
+pnpm format:fix  # prettier write
 ```
+
+## CI/CD
+
+- GitHub Actions handle builds, tests, and publishing.
+- See `docs/CI.md` for details about development snapshots, production releases, S3 Storybook sync, and required secrets.
+
+## Contributing
+
+- Follow the conventions in `AGENTS.md` and `.github/copilot-instructions.md`.
+- Prefer small, focused PRs with tests and stories.