@twoux/ui 0.0.0-stage → 0.1.1

package/LICENSE.md

@@ -0,0 +1,61 @@
+# TwoUX Licence 1.0
+
+Copyright (c) 2026 Giulia Pizzignacco. All rights reserved, except as granted below.
+
+TwoUX is free to use. You may build and ship your own products with it, including commercial products and client work. You may not sell it, give it away or offer it as your own design system, UI kit or component library.
+
+## 1. Definitions
+
+"TwoUX" means everything in this repository and published from it: the component source code, styles, tokens and themes, the documentation, the examples and example apps, and the knowledge files written for people and coding agents (including AGENTS.md, CLAUDE.md, llms.txt, llms-full.txt, docs-md, the rules, the job table and the skills).
+
+"Product" means a website, application, internal tool, service or other software that you, your employer or your client build and offer, whose main value comes from its own features and content rather than from TwoUX.
+
+"You" means the person or organisation using TwoUX under this licence.
+
+## 2. What you may do
+
+Free of charge, worldwide and for as long as you follow this licence, you may:
+
+1. Use, copy and modify TwoUX to design, build and run any number of Products, commercial or not.
+2. Build Products for clients, and hand those Products, including the parts of TwoUX inside them, to the client, who may then use them under this licence.
+3. Distribute TwoUX as part of a Product, in source or compiled form, as long as it is not offered as a separate kit or library (see section 3) and this licence travels with the TwoUX files.
+4. Let your coding agents and tools read TwoUX, including its knowledge files, to write code for your Products.
+5. Fork the public repository to suggest changes back, or to keep a modified copy for your own Products.
+
+## 3. What you may not do
+
+You may not, whether you charge for it or not:
+
+1. Sell, sublicense, rent or lease TwoUX, or any part of it, on its own.
+2. Redistribute or publish TwoUX, a modified version of it, or a substantial part of it, as or inside a design system, UI kit, component library, template, theme, starter kit, code generator, design file or any other product whose main value is TwoUX itself.
+3. Offer a service that lets other people generate, download or copy TwoUX components or knowledge files for their own use.
+4. Use TwoUX, its documentation or its knowledge files to train, fine-tune or evaluate a machine learning model, or to build a dataset for that purpose. Agents reading the files to write code for your Products, as in section 2.4, is allowed.
+5. Remove or change the copyright notice, this licence or the third-party notices.
+
+## 4. Third-party software
+
+TwoUX includes and is built on open-source software, such as shadcn/ui and Radix UI, under their own licences. Those parts stay under their own licences, listed in NOTICE.md. Nothing in this licence limits the rights those licences give you.
+
+## 5. Name and logo
+
+This licence does not give you any right to use the name TwoUX or its logo, except to say truthfully that your Product is built with TwoUX.
+
+## 6. Ending the licence
+
+If you break this licence, your rights under it end automatically. If you fix the breach within 30 days of first learning about it, your rights come back.
+
+## 7. No warranty
+
+To the extent the applicable law allows, TwoUX is provided "as is", without warranty of any kind, express or implied, including the warranties of merchantability, fitness for a particular purpose and non-infringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with TwoUX or its use.
+
+## 8. Contributions
+
+If you send a change, suggestion or other contribution to TwoUX, for example a pull request or an issue, you confirm that you have the right to send it, and you grant Giulia Pizzignacco a perpetual, worldwide, royalty-free and irrevocable licence to use, modify, sublicense and distribute it as part of TwoUX, under this licence or any other.
+
+## 9. Governing law
+
+This licence is governed by the laws of Portugal. The courts of Portugal have jurisdiction over any dispute arising from it or from the use of TwoUX. This does not remove any right the law of your country gives you to bring proceedings where you live.
+
+## 10. Questions
+
+If you are unsure whether your use is allowed, email hi@axdexpert.ai before you ship it.

package/LICENSES/Apache-2.0.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE.md

@@ -0,0 +1,64 @@
+# Third-party notices
+
+TwoUX is copyright (c) 2026 Giulia Pizzignacco and licensed under the TwoUX Licence (LICENSE.md). It includes, adapts or is generated from the open-source work below. Each keeps its own licence, and nothing in the TwoUX Licence limits the rights those licences give you.
+
+## Included or adapted in TwoUX's own files
+
+| Work | Licence | Used for |
+|---|---|---|
+| shadcn/ui, copyright (c) 2023 shadcn | MIT | Component source that TwoUX components are generated from and modify (see packages/ui/SHADCN-DIFF.md) |
+| Impeccable, copyright 2025 Paul Bakaus | Apache 2.0 | Craft checks in the twoux-design skill, adapted and rewritten by Giulia Pizzignacco |
+| board-components (Cloudscape), copyright Amazon.com, Inc. or its affiliates | Apache 2.0 | Board layout behaviour that the board component follows |
+| SVG Logos by Gil Barbara, via Iconify | CC0 1.0 | Most service marks in provider-logos.data.ts |
+| vscode-icons, copyright the vscode-icons contributors, via Iconify | MIT | Microsoft Excel, Word and Outlook marks |
+| theSVG, copyright (c) 2025 thesvg.org, via Iconify | MIT | Google Sheets and Google Docs marks |
+
+The source of every mark is recorded next to it in packages/ui/src/components/provider-logos.data.ts.
+
+## Installed from npm as dependencies
+
+Radix UI Primitives (MIT), Lucide (ISC), cmdk (MIT), Sonner (MIT), tw-animate-css (MIT), React Flow (MIT), react-day-picker (MIT), date-fns (MIT), d3-geo (ISC) and topojson-client (ISC). These are not copied into TwoUX; each package carries its own licence.
+
+## Fonts
+
+The docs site loads Geist and Geist Mono (SIL Open Font License 1.1) from Google Fonts. TwoUX does not include the font files.
+
+## Trademarks
+
+Third-party product names and marks belong to their owners. TwoUX shows them only to identify those products and services, unaltered. Their inclusion does not mean the owners endorse TwoUX.
+
+## Licence texts
+
+### Apache License 2.0
+
+Impeccable and board-components: the full text is in LICENSES/Apache-2.0.txt.
+
+### MIT License: shadcn/ui
+
+Copyright (c) 2023 shadcn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+### MIT License: vscode-icons
+
+Copyright (c) The vscode-icons Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+### MIT License: theSVG
+
+Copyright (c) 2025 thesvg.org
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,3 +1,212 @@
-# Temporary Holding Version
+<div align="center">
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+<img src="https://raw.githubusercontent.com/axdexpert/twoux/main/.github/assets/banner.png?v=2" alt="The TwoUX wordmark surrounded by TwoUX components: keyboard settings, a stat card, a twoux find command, status badges, a list table with two rows selected, the assistant composer and a suggested-changes proposal" width="100%">
+
+# TwoUX
+
+TwoUX is an engineering-first design system for complex apps that makes UI and UX decisions explicit<br>
+for engineers and AI agents, and enforces quality before inconsistent experiences reach production.
+
+**Currently in Beta** · Built on [shadcn/ui](https://ui.shadcn.com) and [Radix](https://www.radix-ui.com), for [React 19+](https://react.dev) and [Tailwind CSS v4](https://tailwindcss.com)
+
+<a href="https://www.npmjs.com/package/@twoux/ui"><img alt="npm version" src="https://img.shields.io/npm/v/@twoux/ui?label=npm&color=5753E0&logo=npm"></a>
+<a href="https://github.com/axdexpert/twoux/blob/main/LICENSE.md"><img alt="Licence: free to use" src="https://img.shields.io/badge/licence-free_to_use-5753E0"></a>
+<a href="#contributing"><img alt="PRs welcome" src="https://img.shields.io/badge/PRs-welcome-brightgreen"></a>
+
+<img alt="121 components" src="https://img.shields.io/badge/components-121-5753E0">
+<img alt="46 patterns" src="https://img.shields.io/badge/patterns-46-5753E0">
+<img alt="WCAG 2.2 AA" src="https://img.shields.io/badge/WCAG-2.2_AA-00704A">
+<a href="#connect-over-mcp"><img alt="MCP server included" src="https://img.shields.io/badge/MCP-server_included-17171F"></a>
+
+**[Quick start](#quick-start-with-your-agent)** · **[Rules for agents](https://github.com/axdexpert/twoux/blob/main/AGENTS.md)** · **[Every page](https://github.com/axdexpert/twoux/blob/main/llms.txt)** · **[Why TwoUX](#why-twoux)** · **[Contributing](#contributing)** · **[Licence](https://github.com/axdexpert/twoux/blob/main/LICENSE.md)**
+
+</div>
+
+## Overview
+
+Engineers now build UI through coding agents, often with no designer in the loop and no Figma file to check against. Design systems ship components, not decisions, so the agent picks the nearest piece and fills every gap with a guess. TwoUX writes those decisions down: which component fits which job, how a flow behaves, when to confirm and when to offer Undo, each grounded in published usability research, WCAG, WAI-ARIA and the design systems of major SaaS products.
+
+It ships 121 compact, keyboard-first components for dense B2B apps, 122 jobs, 46 patterns, light and dark themes, a theme generator that checks contrast, a lint, an MCP server and agent skills as one system. People and AI agents read the same rules and get the same answers.
+
+**What makes TwoUX different:**
+
+- **Agent Experience on both sides.** The coding agent that builds the UI gets rules it can read and follow: `AGENTS.md`, `llms.txt`, a Markdown page per component and skills to build, audit and propose. The people who supervise agents inside the product get components for plans, approvals, run timelines and permissions.
+- **A knowledge base, not a component list.** 122 jobs, each mapped to one component with what to use instead, and 46 patterns that walk through whole flows step by step. Every rule carries its reason and its numbered sources.
+- **Complex, never complicated.** Dense tables, spreadsheet grids, charts and AI agent interfaces, compact and keyboard-first, in light and dark, with the right interactions, states and motion built in. WCAG 2.2 AA.
+- **Guardrails over guidelines.** A lint for raw values and local copies, a Claude Code hook that blocks edits to the system, a browser audit for contrast, focus and spacing, and a theme file that refuses colours that fail WCAG.
+
+## Quick start with your agent
+
+Paste this into Claude Code, Cursor, Codex or Copilot:
+
+```text
+Set up the TwoUX design system in this project.
+1. Install @twoux/ui with this repo's package manager.
+2. Run `npx twoux init`, then read node_modules/@twoux/ui/agent/AGENTS.md.
+3. For every UI job, find the component with `npx twoux find "<job>"` (or the twoux MCP server's find_component tool) and read its page before writing code.
+4. Before you finish, run `npx twoux check` and fix every error.
+```
+
+Then give it your brand:
+
+```text
+Give this app our brand with TwoUX.
+1. Set primary, radius and font in twoux.theme.json to match our brand.
+2. Run `npx twoux theme`.
+3. Import ./twoux-theme.css after @twoux/ui/styles.css.
+If the generator refuses a colour for contrast, use the closest colour it accepts and tell me which.
+```
+
+## Getting started
+
+Requires React 19 and Tailwind CSS v4.
+
+**1. Install**
+
+```bash
+npm install @twoux/ui
+# or
+pnpm add @twoux/ui
+# or
+yarn add @twoux/ui
+```
+
+**2. Set up your agents**
+
+```bash
+npx twoux init
+```
+
+This adds the TwoUX rules to `AGENTS.md` and `CLAUDE.md`, connects the MCP server, and adds the TwoUX skills, a guard hook and `twoux.theme.json`. It never overwrites a file; it adds to what is there.
+
+**3. Import the styles and use a component**
+
+```tsx
+import '@twoux/ui/styles.css';
+import { Button, Toaster, toast } from '@twoux/ui';
+
+export function App() {
+  return (
+    <>
+      <Button shortcut="C" onClick={() => toast.success('Listing created')}>
+        New listing
+      </Button>
+      <Toaster />
+    </>
+  );
+}
+```
+
+**4. Check before you merge**
+
+```bash
+npx twoux check
+```
+
+## Connect over MCP
+
+`npx twoux init` connects it for you. To add it by hand:
+
+| Tool        | Command or file                                                                                                             |
+| ----------- | --------------------------------------------------------------------------------------------------------------------------- |
+| Claude Code | `claude mcp add twoux -- npx -y @twoux/ui mcp`                                                                              |
+| Codex       | `codex mcp add twoux -- npx -y @twoux/ui mcp`                                                                               |
+| Cursor      | `.cursor/mcp.json`: `{ "mcpServers": { "twoux": { "command": "npx", "args": ["-y", "@twoux/ui", "mcp"] } } }`               |
+| VS Code     | `.vscode/mcp.json`: `{ "servers": { "twoux": { "type": "stdio", "command": "npx", "args": ["-y", "@twoux/ui", "mcp"] } } }` |
+
+The server runs on your machine and reads only the installed package. Its tools: `find_component`, `get_doc`, `list_docs`, `get_rules` and `check`.
+
+## The twoux command
+
+| Command                  | What it does                                                                      |
+| ------------------------ | --------------------------------------------------------------------------------- |
+| `npx twoux init`         | Sets up the project for AI agents. `--principles` for an app not built with TwoUX |
+| `npx twoux find "<job>"` | Names the component or pattern for a job, how to use it and what not to use       |
+| `npx twoux docs [id]`    | Lists every page, or prints one. `docs rules` prints every rule                   |
+| `npx twoux check`        | Lints app code against TwoUX's rules. Exits 1 on errors                           |
+| `npx twoux theme`        | Builds `twoux-theme.css` from `twoux.theme.json`, checking contrast               |
+| `npx twoux mcp`          | Runs the MCP server                                                               |
+
+## Packages
+
+| Package                    | Description                                                                     |
+| -------------------------- | ------------------------------------------------------------------------------- |
+| [`@twoux/ui`](https://github.com/axdexpert/twoux/tree/main/packages/ui) | Components, tokens, styles, agent files, the `twoux` command and the MCP server |
+| [`twoux`](https://github.com/axdexpert/twoux/tree/main/packages/twoux)  | Runs `npx twoux` with the `@twoux/ui` installed in your project                 |
+
+## Why TwoUX
+
+### Building got faster and cheaper. So did inconsistency.
+
+Building and shipping UI has never been faster or cheaper. Consistency didn't come with it. AI doesn't fix the mess, it scales it. Engineers build through coding agents, often with no designer in the loop and no Figma file to check against. But design systems ship components, not decisions. A button doesn't say when not to use it. So the agent picks the nearest piece and fills every gap with a guess.
+
+Each guess looks fine on its own: a modal for record detail, a disabled submit, an error in a toast, a delete with no Undo. Together they turn one product into five. That debt shows up later as duplicated components, accessibility fixes and screens that each behave differently.
+
+|        |                                                                               |
+| ------ | ----------------------------------------------------------------------------- |
+| **13** | engineers per designer in AI-company job postings¹                            |
+| **4×** | more cloned code since AI coding assistants²                                  |
+| **0**  | rules on when not to use a dialog in the docs of popular component libraries³ |
+
+<sub>¹ Applied Methods, analysis of 9,281 open roles at AI companies, 2026. ² GitClear, AI Copilot Code Quality 2025: 211M changed lines, 2020 to 2024. ³ Dialog pages of shadcn/ui and Radix, checked November 2026: API and examples, no guidance on when to use or avoid it.</sub>
+
+The design systems out there weren't built for this. Most give you components, often basic ones, and stop there:
+
+- **No Agent Experience.** Written for people browsing docs, not for an AI agent that needs rules it can read and follow.
+- **Not built for complex B2B.** Buttons and cards, but not the dense tables, spreadsheet grids, dashboards and AI interfaces B2B products run on.
+- **No logic, no UX.** What a component looks like, but not which job it's for, how the flow behaves, or when to confirm and when to offer Undo.
+- **No guardrails.** Nothing stops an agent from inventing a grey, rebuilding a dropdown or shipping AI slop.
+
+### Nobody needs more components
+
+Engineers and product teams don't need more components. They need what the best UX designers and the design systems of market-leading products already know, written down where every agent can read it and every check can enforce it.
+
+TwoUX is a research-backed knowledge base built on UX expertise. It decides the UX, not only the look: which component fits which job, how a flow behaves, when to confirm and when to offer Undo. None of it is an LLM's opinion. Every decision is grounded in published usability research, WCAG, WAI-ARIA and the design systems of major SaaS products, and every component page explains its decisions with numbered sources.
+
+## Tested on real agents
+
+Claude Opus, Sonnet and Haiku, given realistic developer requests in a TwoUX project and never told the rules, November 2026:
+
+| Result       | What it means                                                               |
+| ------------ | --------------------------------------------------------------------------- |
+| **0 of 14**  | runs changed the design system without being asked                          |
+| **10 of 10** | planted UX problems found by every model, including the 4 no linter can see |
+| **3 of 3**   | rebrands went through the theme file, not page-by-page overrides            |
+
+The four problems only the rules caught are the judgement calls a designer makes: a modal for record detail, a disabled submit, an error in a toast and a delete without Undo. When a developer insisted on editing a component directly, two of three models did, and `twoux check` caught both. Every failure became a new check.
+
+## Built by a UX engineer, for engineers and their agents
+
+TwoUX stands on the shoulders of the brilliant minds behind every source it cites. I started from a decade of UX decisions I kept explaining in reviews, and the mistakes I kept fixing in agent-written UI, then researched how standards and mature SaaS design systems solve each one. Each answer became a rule, a job or a pattern step, with its source (611 links, all checked).
+
+Components are generated from shadcn's untouched source by a script, so the API stays familiar to engineers and agents. The docs site and the agent files come from the same content, so people and agents get the same answer.
+
+Giulia Pizzignacco, founder and UX engineer
+
+## Project structure
+
+| Directory         | Purpose                                                             |
+| ----------------- | ------------------------------------------------------------------- |
+| `apps/docs`       | The docs site, with live examples and example apps                  |
+| `apps/playground` | A sandbox app built only from TwoUX                                 |
+| `packages/ui`     | The `@twoux/ui` package                                             |
+| `packages/twoux`  | The `twoux` command package                                         |
+| `docs-md/`        | One Markdown page per foundation, component and pattern, for agents |
+| `scripts/`        | Generators for the agent files, theme, palette and checks           |
+
+## Contributing
+
+Issues and pull requests are welcome. By sending one, you agree to the contribution terms in section 8 of the licence.
+
+```bash
+corepack enable
+pnpm install
+pnpm dev        # docs site on http://localhost:3100
+pnpm verify     # type check, interaction, responsive and design checks
+```
+
+To report a security problem, follow [SECURITY.md](https://github.com/axdexpert/twoux/blob/main/SECURITY.md).
+
+## Licence
+
+Free to use under the [TwoUX Licence](https://github.com/axdexpert/twoux/blob/main/LICENSE.md): build and ship any number of your own products with it, including commercial products and client work. Don't sell or republish TwoUX, or a modified copy, as a design system, UI kit, template or component library, and don't train models on it. Third-party notices are in [NOTICE.md](https://github.com/axdexpert/twoux/blob/main/NOTICE.md).