@deriv-ds/design-intelligence-layer 0.4.4 → 0.4.5

package/README.md

@@ -6,23 +6,6 @@ Published as **`@deriv-ds/design-intelligence-layer`** on npm.
 
 ---
 
-## License & FontAwesome Pro — read before installing
-
-This package is **proprietary to Deriv** (`"license": "UNLICENSED"`). It is not open source and must never be published with public access or mirrored to a public registry.
-
-The icon system depends on **FontAwesome Pro**, which is commercially licensed to Deriv on a **per-seat basis**. Compliance rules:
-
-1. **Only licensed seat-holders may install or build this package.** FontAwesome counts every developer who uses Pro icons during development as a seat. Currently this is restricted to one designated engineer — do not share registry access beyond licensed seats.
-2. **Token setup (required to install).** The FA registry token is read from an environment variable — it is never stored in the repo. The designated engineer adds this to their shell profile (and CI adds it as a masked secret):
-
-   ```bash
-   export FONTAWESOME_NPM_AUTH_TOKEN=<token from the Deriv FontAwesome account>
-   ```
-
-   The committed-ignored `.npmrc` references it as `${FONTAWESOME_NPM_AUTH_TOKEN}`. Without the variable set, `npm install` fails loudly — that is intentional.
-3. **Never bundle FA glyph data.** FA packages must stay in `dependencies` (tsup externalizes them) so the published tarball contains no FontAwesome code. Do not add `@fortawesome/*` to tsup's bundled output.
-4. **Never commit the token.** `.npmrc` is gitignored; the token lives only in shell profiles and CI secrets. If it ever leaks, regenerate it at fontawesome.com → Account.
-
 ## Quick Start
 
 ### Installation
@@ -96,6 +79,19 @@ npm install react react-dom tailwindcss
 
 > Requires React 18+ and Tailwind CSS v4+.
 
+### Icons
+
+Icons use **FontAwesome Pro 6** (Deriv-licensed). Do not install `lucide-react` — it is not used in this package. Use the bundled `Icon` component:
+
+```tsx
+import { Icon } from "@deriv-ds/design-intelligence-layer"
+
+<Icon name="bell" />
+<Icon name="circle-check" weight="fill" className="text-success" />
+```
+
+The full icon catalog is at `node_modules/@deriv-ds/design-intelligence-layer/guides/design-system-guide/icon-reference.md`.
+
 ---
 
 ## What's inside
@@ -710,7 +706,7 @@ This project uses @deriv-ds/design-intelligence-layer (Quill Design System). Bef
 4. Read node_modules/@deriv-ds/design-intelligence-layer/guides/brand-voice/quill-brand-voice.md — apply the brand voice: channel-specific voice, banned phrases, vocabulary, and formatting rules for all player-facing copy
 5. Check if the component exists in the package — import it, don't re-implement
 6. Use only design token classes (bg-prominent, text-on-prominent, border-border-subtle, etc.) — no hardcoded hex or raw Tailwind palette colors
-7. Do not install icon libraries (lucide-react etc.), tailwindcss, or other bundled dependencies separately — icons come from FontAwesome Pro via the <Icon /> component (see guides/design-system-guide/icon-reference.md for the full catalog and weight conventions)
+7. Do not install lucide-react — icons use FontAwesome Pro via the bundled Icon component; do not install tailwindcss or other bundled dependencies separately
 8. If no token exists for a value, ask before using a hardcoded value
 9. After upgrading the package: prefer package imports over local copies of components; if replacing local UI code with the package version, tell the user what was overwritten; re-copy guides/rules/design-system-consuming-project.mdc into .cursor/rules if using Cursor
 
@@ -736,7 +732,7 @@ See node_modules/@deriv-ds/design-intelligence-layer/README.md for complete toke
 | `bg-[var(--primary)]` | `bg-primary` | Raw CSS var — Tailwind v4 maps tokens directly |
 | `hsl(var(--primary))` | `bg-primary` | Tailwind v3 syntax — not needed in v4 |
 | `font-[Plus_Jakarta_Sans]` | `font-sans` (Inter) | Project font is Inter, not Plus Jakarta Sans |
-| Importing `lucide-react` | `<Icon name="..." />` | Icons are FontAwesome Pro via the bundled `<Icon />` component — see `guides/design-system-guide/icon-reference.md` |
+| `import ... from 'lucide-react'` | `import { Icon } from "@deriv-ds/design-intelligence-layer"` | Icons use FontAwesome Pro — lucide-react is not in this package |
 
 ---
 
@@ -744,7 +740,7 @@ See node_modules/@deriv-ds/design-intelligence-layer/README.md for complete toke
 
 These are bundled with the package. Installing them separately can cause version conflicts:
 
-- `@fortawesome/*` and `@awesome.me/*` — FontAwesome Pro icon packages, used through the exported `<Icon />` component (never imported directly in consuming code)
+- `lucide-react` — **not used**; icons are FontAwesome Pro via the bundled `Icon` component
 - `radix-ui` — headless primitives
 - `class-variance-authority` — variant API
 - `cmdk` — command palette