@joanroucoux/cairn-ui 0.8.0 → 0.8.1

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.8.1
+
+### Added
+
+- The npm page now carries a README: what the package is, how to install it, the stylesheets and the `@source`
+  line to add, the `fonts.css` setup and the per-folder imports.
+- The Storybook is published at https://joanroucoux.github.io/cairn-ui/ on every push to `main`.
+- A GitHub Release is created for every `vX.Y.Z` tag, with the matching section of this changelog as its notes.
+
+### Changed
+
+- Stories and specs use fictional data. No component or style changes.
+
 ## 0.8.0
 
 ### Breaking

package/README.md

@@ -0,0 +1,67 @@
+# @joanroucoux/cairn-ui
+
+A monochrome, accessible Angular design system, built for [Cairn](https://github.com/JoanRoucoux/cairn).
+
+Browse every component, live, in the [Storybook](https://joanroucoux.github.io/cairn-ui/).
+
+## Installation
+
+```bash
+pnpm add @joanroucoux/cairn-ui
+```
+
+Peer dependencies: `@angular/common` and `@angular/core`, version 22. The styles use Tailwind CSS 4, which the consuming
+application provides.
+
+## Setup
+
+Import three stylesheets, in order, and register the package as a Tailwind source (templates in `node_modules` are
+not scanned by default):
+
+```css
+@import 'tailwindcss';
+@import '@joanroucoux/cairn-ui/styles/tokens.css';
+@import '@joanroucoux/cairn-ui/styles/theme.css';
+@import '@joanroucoux/cairn-ui/styles/motion.css';
+@source '../node_modules/@joanroucoux/cairn-ui';
+```
+
+`fonts.css` self-hosts Rubik and must not be imported through the Tailwind entry above: its `@font-face` rules use
+`url(./fonts/...)` paths relative to the file, and Tailwind's CSS-first pipeline does not rebase them. Add it to the
+`styles` array of `angular.json` instead:
+
+```json
+"styles": ["src/styles.css", "node_modules/@joanroucoux/cairn-ui/styles/fonts.css"]
+```
+
+An application that does not use Tailwind can import `@joanroucoux/cairn-ui/styles/tokens.css` alone: it is a pure
+token sheet.
+
+## Usage
+
+The package root exports nothing. Each component folder is its own entry point, so your bundler only ships what you
+import:
+
+```ts
+import { Component } from '@angular/core';
+
+import { UiBadge } from '@joanroucoux/cairn-ui/badge';
+import { UiButton } from '@joanroucoux/cairn-ui/button';
+
+@Component({
+  selector: 'app-example',
+  imports: [UiButton, UiBadge],
+  template: `
+    <ui-badge>Synced</ui-badge>
+    <button ui-button>Save</button>
+  `,
+})
+export class Example {}
+```
+
+## More
+
+- [Repository README](https://github.com/JoanRoucoux/cairn-ui#readme): the component list, design principles and development guide
+- [Changelog](https://github.com/JoanRoucoux/cairn-ui/blob/main/projects/ui/CHANGELOG.md)
+
+MIT licensed.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@joanroucoux/cairn-ui",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "description": "Cairn UI — a monochrome, accessible Angular design system.",
   "keywords": [
     "angular",