@drivexstudio/animations 1.0.0 → 1.0.1

package/README.md

@@ -10,6 +10,30 @@ npm install @drivexstudio/animations
 
 `react` and `react-dom` (>=18) are peer dependencies — install them in your app if they aren't already.
 
+**This package requires Tailwind CSS v3+ in the consuming app**, plus a few design tokens that are NOT part of Tailwind's default theme. Components are styled with Tailwind utility classes rather than shipping compiled CSS, so if these tokens aren't already defined in your project, classes like `bg-brand` produce no CSS at all — components render unstyled with no error.
+
+Your app must already define, under the **exact names** below (this package does not ship a preset or CSS file — add these to your own `tailwind.config.js` theme and global CSS if they don't already exist):
+
+| Token | Type | Used for |
+|---|---|---|
+| `brand` | Tailwind color | `bg-brand`, `text-brand` |
+| `background` | Tailwind color | `bg-background`, `ring-offset-background` |
+| `body-sm` | Tailwind fontSize | `text-body-sm` |
+| `body` | Tailwind fontSize | `text-body` |
+| `body-lg` | Tailwind fontSize | `text-body-lg` |
+| `--ease-power4-in-out` | CSS custom property | inline `transition-timing-function` on hover/press micro-interactions |
+
+Also make sure Tailwind's `content` config scans this package's compiled output, or it will purge classes it thinks are unused:
+
+```js
+content: [
+  './src/**/*.{js,jsx,ts,tsx}',
+  './node_modules/@drivexstudio/animations/dist/**/*.{js,cjs}'
+]
+```
+
+> A Tailwind preset + base CSS file shipping these tokens with sensible defaults previously lived in this package and can be reintroduced later if useful across multiple consuming projects — for now this documents the requirement instead.
+
 ## Setup
 
 Some components depend on context providers being mounted above them in your app tree. Wrap your root layout once: