@ngrr/ds 0.1.27 → 0.1.31

package/README.md

@@ -1 +1,50 @@
-# DSN
+# DS-Nagarro
+
+AI-first React component library.
+
+---
+
+## For AI agents
+
+Read `node_modules/@ngrr/ds/AI.md` before writing any code.
+That file contains all the rules for using this design system correctly — layout, tokens, patterns, and component usage guidelines.
+
+Add this to your project's `.cursorrules` to load it automatically:
+
+```
+Read node_modules/@ngrr/ds/AI.md before writing any code.
+```
+
+---
+
+## Setup
+
+```bash
+npm install @ngrr/ds --legacy-peer-deps
+```
+
+```tsx
+// main.tsx — before everything else
+import '@ngrr/ds/style.css'
+import '@ngrr/ds/tokens.css'
+```
+
+```css
+/* index.css */
+html, body { margin: 0; height: 100%; }
+#root { height: 100%; display: flex; flex-direction: column; box-sizing: border-box; }
+```
+
+---
+
+## Resources
+
+- **Storybook:** https://699f3dfd3540c3f346868d55-kmskdmltrn.chromatic.com/
+- **Usage rules:** `node_modules/@ngrr/ds/AI.md`
+- **Contributing:** `AGENTS.md` in the source repository
+
+---
+
+## Stack
+
+React 18+ · TypeScript · Styled Components v6 · Vite

package/dist/components/atoms/Badge/Badge.d.ts

@@ -1,11 +1,11 @@
-export type BadgeSize = 'sm' | 'lg' | 'dot';
+export type BadgeSize = 'sm' | 'dot';
 export type BadgeVariant = 'highlight-soft' | 'highlight-strong' | 'informative' | 'inverted' | 'critical';
 export interface BadgeProps {
     /**
      * Visual size of the badge.
-     * - `sm`  — 16 × 16 px minimum; shows count text.
-     * - `lg`  — 24 × 24 px minimum; shows count text.
-     * - `dot` — 8 × 8 px circle; no text; use for presence/status signals only.
+     * - `sm`  — 16px visual pill (--size-16) inside a transparent wrapper with
+     *           4px padding-block (--inset-tiny), giving a 24px total footprint.
+     * - `dot` — 8px circle (--size-8); no text; use for presence signals only.
      * @default 'sm'
      */
     size?: BadgeSize;