Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
[![Docs](https://github.com/sawfwair/dkcli/actions/workflows/docs.yml/badge.svg)](https://github.com/sawfwair/dkcli/actions/workflows/docs.yml)
[![npm](https://img.shields.io/npm/v/%40dkcli%2Fcli?color=%23af6100)](https://www.npmjs.com/package/@dkcli/cli)

<p align="center">
<img src="docs/public/readme-hero.svg" alt="DesignKit CLI turns a seed color into palette, type, motion, layout, and proof outputs." width="100%" />
</p>

Proof-driven design tooling for teams that want interface decisions to leave evidence behind.

DesignKit ships a deterministic CLI and package workspace for OKLCH palettes, APCA contrast, fluid scales, motion curves, optical corrections, layout rails, composition scoring, typography recommendations, CSS audits, token emission, and Svelte 5 component recipes.
Expand Down Expand Up @@ -47,6 +51,10 @@ dk text --font 18 --measure 680 --contrast 72
dk audit --css app.css
```

<p align="center">
<img src="docs/public/readme-proof.svg" alt="A generated DesignKit proof snapshot with palette swatches, APCA passes, layout metrics, and motion output." width="100%" />
</p>

## Packages

- `@dkcli/cli`: the `dk` and `dkcli` command line tools.
Expand All @@ -64,6 +72,10 @@ dk audit --css app.css
| Layout | `layout`, `compose`, `saliency`, `future` | Solve rails, score composition, and explore content topology. |
| Product | `components`, `cms` | Verify component recipes and manage hosted DKCMS content. |

<p align="center">
<img src="docs/public/readme-map.svg" alt="DesignKit command families flowing into CLI, core, tokens, and components packages." width="100%" />
</p>

## Local Development

Use Node 22 or newer and pnpm 10.33.0.
Expand Down
77 changes: 77 additions & 0 deletions docs/public/readme-hero.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
66 changes: 66 additions & 0 deletions docs/public/readme-map.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
74 changes: 74 additions & 0 deletions docs/public/readme-proof.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading