From c03d85ebbb681f371cd4e96c98782b7800b6a5da Mon Sep 17 00:00:00 2001 From: Neelank Sachan Date: Tue, 29 Sep 2026 07:20:11 +1000 Subject: [PATCH] README: every package on npm, 37 of them, with its version Adds @polyxd/ds-kit to the packages table, a version column to the thirteen design-system packs, and a table of the twelve templates; links the scope to the @polyxd organisation on npm. Co-Authored-By: Claude Opus 5.5 --- README.md | 54 +++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 37 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index abb172d..b4a9d06 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # Polyxd -[![@polyxd/react](https://img.shields.io/npm/v/@polyxd/react?label=%40polyxd%2Freact&color=FF6E40)](https://www.npmjs.com/package/@polyxd/react) [![@polyxd/web](https://img.shields.io/npm/v/@polyxd/web?label=%40polyxd%2Fweb&color=FF6E40)](https://www.npmjs.com/package/@polyxd/web) [![@polyxd/spec](https://img.shields.io/npm/v/@polyxd/spec?label=%40polyxd%2Fspec&color=FF6E40)](https://www.npmjs.com/package/@polyxd/spec) [![@polyxd/verifier](https://img.shields.io/npm/v/@polyxd/verifier?label=%40polyxd%2Fverifier&color=FF6E40)](https://www.npmjs.com/package/@polyxd/verifier) [![polyxd](https://img.shields.io/npm/v/polyxd?label=polyxd&color=FF6E40)](https://www.npmjs.com/package/polyxd) [![npm scope](https://img.shields.io/badge/npm-%40polyxd-141413)](https://www.npmjs.com/search?q=%40polyxd) [![Licence](https://img.shields.io/badge/licence-Apache--2.0-141413)](LICENSE) +[![@polyxd/react](https://img.shields.io/npm/v/@polyxd/react?label=%40polyxd%2Freact&color=FF6E40)](https://www.npmjs.com/package/@polyxd/react) [![@polyxd/web](https://img.shields.io/npm/v/@polyxd/web?label=%40polyxd%2Fweb&color=FF6E40)](https://www.npmjs.com/package/@polyxd/web) [![@polyxd/spec](https://img.shields.io/npm/v/@polyxd/spec?label=%40polyxd%2Fspec&color=FF6E40)](https://www.npmjs.com/package/@polyxd/spec) [![@polyxd/verifier](https://img.shields.io/npm/v/@polyxd/verifier?label=%40polyxd%2Fverifier&color=FF6E40)](https://www.npmjs.com/package/@polyxd/verifier) [![polyxd](https://img.shields.io/npm/v/polyxd?label=polyxd&color=FF6E40)](https://www.npmjs.com/package/polyxd) [![npm scope](https://img.shields.io/badge/npm-%40polyxd-141413)](https://www.npmjs.com/org/polyxd) [![Licence](https://img.shields.io/badge/licence-Apache--2.0-141413)](LICENSE) **An open spec, renderer and verifier for interfaces generated on demand** — rendered natively in your design system, operable by people and agents alike, and checked before anyone sees them. @@ -22,7 +22,7 @@ request ──► generator (any model or program that emits spec-valid JSON) ## Packages on npm -Everything is on npm under [`@polyxd`](https://www.npmjs.com/search?q=%40polyxd), plus the `polyxd` CLI and a `@polyxd/ds-*` package per design system. +All 37 packages are on npm under the [`@polyxd` organisation](https://www.npmjs.com/org/polyxd): the twelve below, the `polyxd` CLI among them, then [thirteen design-system packs](#the-design-systems) and [twelve templates](#the-templates). | Package | What it is | Version | |---|---|---| @@ -37,6 +37,7 @@ Everything is on npm under [`@polyxd`](https://www.npmjs.com/search?q=%40polyxd) | [`@polyxd/mcp`](https://www.npmjs.com/package/@polyxd/mcp) | An MCP server: the spec, checks and live screens for a host's model | [![@polyxd/mcp](https://img.shields.io/npm/v/@polyxd/mcp?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/mcp) | | [`@polyxd/a2ui`](https://www.npmjs.com/package/@polyxd/a2ui) | Export to A2UI | [![@polyxd/a2ui](https://img.shields.io/npm/v/@polyxd/a2ui?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/a2ui) | | [`@polyxd/analytics`](https://www.npmjs.com/package/@polyxd/analytics) | Adapters for the renderers' semantic events | [![@polyxd/analytics](https://img.shields.io/npm/v/@polyxd/analytics?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/analytics) | +| [`@polyxd/ds-kit`](https://www.npmjs.com/package/@polyxd/ds-kit) | Builds design-system packs, including yours with `polyxd pack` | [![@polyxd/ds-kit](https://img.shields.io/npm/v/@polyxd/ds-kit?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/ds-kit) | ## What works today @@ -54,24 +55,43 @@ All 24 examples score 100 across **1,248 renders** (13 packs × 2 widths × ligh ### The design systems -| | Design system | Pack | -|---|---|---| -| | Material 3 | [`@polyxd/ds-material3`](packages/ds-material3/) | -| | IBM Carbon | [`@polyxd/ds-carbon`](packages/ds-carbon/) | -| | Ant Design | [`@polyxd/ds-antd`](packages/ds-antd/) | -| | Microsoft Fluent 2 | [`@polyxd/ds-fluent`](packages/ds-fluent/) | -| | shadcn/ui | [`@polyxd/ds-shadcn`](packages/ds-shadcn/) | -| | Bootstrap 5 | [`@polyxd/ds-bootstrap`](packages/ds-bootstrap/) | -| | Mantine 8 | [`@polyxd/ds-mantine`](packages/ds-mantine/) | -| | Radix Themes 3 | [`@polyxd/ds-radix`](packages/ds-radix/) | -| | Shopify Polaris | [`@polyxd/ds-polaris`](packages/ds-polaris/) | -| | GitHub Primer | [`@polyxd/ds-primer`](packages/ds-primer/) | -| | Adobe Spectrum 2 | [`@polyxd/ds-spectrum`](packages/ds-spectrum/) | -| | GOV.UK Design System | [`@polyxd/ds-govuk`](packages/ds-govuk/) | -| | Chakra UI 3 | [`@polyxd/ds-chakra`](packages/ds-chakra/) | +| | Design system | Pack | Version | +|---|---|---|---| +| | Material 3 | [`@polyxd/ds-material3`](packages/ds-material3/) | [![@polyxd/ds-material3](https://img.shields.io/npm/v/@polyxd/ds-material3?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/ds-material3) | +| | IBM Carbon | [`@polyxd/ds-carbon`](packages/ds-carbon/) | [![@polyxd/ds-carbon](https://img.shields.io/npm/v/@polyxd/ds-carbon?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/ds-carbon) | +| | Ant Design | [`@polyxd/ds-antd`](packages/ds-antd/) | [![@polyxd/ds-antd](https://img.shields.io/npm/v/@polyxd/ds-antd?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/ds-antd) | +| | Microsoft Fluent 2 | [`@polyxd/ds-fluent`](packages/ds-fluent/) | [![@polyxd/ds-fluent](https://img.shields.io/npm/v/@polyxd/ds-fluent?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/ds-fluent) | +| | shadcn/ui | [`@polyxd/ds-shadcn`](packages/ds-shadcn/) | [![@polyxd/ds-shadcn](https://img.shields.io/npm/v/@polyxd/ds-shadcn?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/ds-shadcn) | +| | Bootstrap 5 | [`@polyxd/ds-bootstrap`](packages/ds-bootstrap/) | [![@polyxd/ds-bootstrap](https://img.shields.io/npm/v/@polyxd/ds-bootstrap?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/ds-bootstrap) | +| | Mantine 8 | [`@polyxd/ds-mantine`](packages/ds-mantine/) | [![@polyxd/ds-mantine](https://img.shields.io/npm/v/@polyxd/ds-mantine?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/ds-mantine) | +| | Radix Themes 3 | [`@polyxd/ds-radix`](packages/ds-radix/) | [![@polyxd/ds-radix](https://img.shields.io/npm/v/@polyxd/ds-radix?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/ds-radix) | +| | Shopify Polaris | [`@polyxd/ds-polaris`](packages/ds-polaris/) | [![@polyxd/ds-polaris](https://img.shields.io/npm/v/@polyxd/ds-polaris?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/ds-polaris) | +| | GitHub Primer | [`@polyxd/ds-primer`](packages/ds-primer/) | [![@polyxd/ds-primer](https://img.shields.io/npm/v/@polyxd/ds-primer?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/ds-primer) | +| | Adobe Spectrum 2 | [`@polyxd/ds-spectrum`](packages/ds-spectrum/) | [![@polyxd/ds-spectrum](https://img.shields.io/npm/v/@polyxd/ds-spectrum?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/ds-spectrum) | +| | GOV.UK Design System | [`@polyxd/ds-govuk`](packages/ds-govuk/) | [![@polyxd/ds-govuk](https://img.shields.io/npm/v/@polyxd/ds-govuk?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/ds-govuk) | +| | Chakra UI 3 | [`@polyxd/ds-chakra`](packages/ds-chakra/) | [![@polyxd/ds-chakra](https://img.shields.io/npm/v/@polyxd/ds-chakra?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/ds-chakra) | Each logo is its owner's own file, unaltered, used to identify the design system a pack is modelled on (where a system has no mark of its own, its company's logo). Several owners' guidelines restrict logo use without permission; each pack's README records the source and the guidelines. GOV.UK's crown and logotype are protected, so it is named in words alone. Twelve original templates (`sketch`, `wireframe`, `editorial`, `brutalist`, `glass`, `terminal`, `pastel`, `civic`, `finance`, `health`, `neon`, `mono`) sit beside them, each with a mark drawn from its own tokens. +### The templates + +Twelve original packs, made to be copied and changed. + +| Template | Pack | Version | +|---|---|---| +| Brutalist | [`@polyxd/ds-brutalist`](packages/ds-brutalist/) | [![@polyxd/ds-brutalist](https://img.shields.io/npm/v/@polyxd/ds-brutalist?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/ds-brutalist) | +| Civic | [`@polyxd/ds-civic`](packages/ds-civic/) | [![@polyxd/ds-civic](https://img.shields.io/npm/v/@polyxd/ds-civic?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/ds-civic) | +| Editorial | [`@polyxd/ds-editorial`](packages/ds-editorial/) | [![@polyxd/ds-editorial](https://img.shields.io/npm/v/@polyxd/ds-editorial?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/ds-editorial) | +| Finance | [`@polyxd/ds-finance`](packages/ds-finance/) | [![@polyxd/ds-finance](https://img.shields.io/npm/v/@polyxd/ds-finance?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/ds-finance) | +| Glass | [`@polyxd/ds-glass`](packages/ds-glass/) | [![@polyxd/ds-glass](https://img.shields.io/npm/v/@polyxd/ds-glass?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/ds-glass) | +| Health | [`@polyxd/ds-health`](packages/ds-health/) | [![@polyxd/ds-health](https://img.shields.io/npm/v/@polyxd/ds-health?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/ds-health) | +| Mono | [`@polyxd/ds-mono`](packages/ds-mono/) | [![@polyxd/ds-mono](https://img.shields.io/npm/v/@polyxd/ds-mono?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/ds-mono) | +| Neon | [`@polyxd/ds-neon`](packages/ds-neon/) | [![@polyxd/ds-neon](https://img.shields.io/npm/v/@polyxd/ds-neon?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/ds-neon) | +| Pastel | [`@polyxd/ds-pastel`](packages/ds-pastel/) | [![@polyxd/ds-pastel](https://img.shields.io/npm/v/@polyxd/ds-pastel?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/ds-pastel) | +| Sketch | [`@polyxd/ds-sketch`](packages/ds-sketch/) | [![@polyxd/ds-sketch](https://img.shields.io/npm/v/@polyxd/ds-sketch?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/ds-sketch) | +| Terminal | [`@polyxd/ds-terminal`](packages/ds-terminal/) | [![@polyxd/ds-terminal](https://img.shields.io/npm/v/@polyxd/ds-terminal?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/ds-terminal) | +| Wireframe | [`@polyxd/ds-wireframe`](packages/ds-wireframe/) | [![@polyxd/ds-wireframe](https://img.shields.io/npm/v/@polyxd/ds-wireframe?label=&color=FF6E40)](https://www.npmjs.com/package/@polyxd/ds-wireframe) | + ## Try it ```sh