pattern-dump 0.1.0-alpha.0

package/LICENSE

@@ -0,0 +1,8 @@
+MIT License
+
+Copyright (c) 2026 n8d and 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, subject to the conditions of the MIT License.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND.

package/README.md

@@ -0,0 +1,92 @@
+# Pattern Dump
+
+A workbench for HTML and CSS design systems, and a successor to PatternLab. Write components as
+Handlebars templates with SCSS, data and Markdown docs; Pattern Dump shows them live, checks them, maps
+how they relate, and publishes the result as a static site.
+
+> **Alpha (0.1.0-alpha.0).** Published under the `alpha` tag. Options and file conventions can still change
+> between releases.
+
+## Requirements
+
+Node.js 20.10 or later, and npm.
+
+## Quick start
+
+Create a new project:
+
+```bash
+npx pattern-dump@alpha init my-design-system
+cd my-design-system
+npm run dev              # → http://localhost:4000
+```
+
+Or add Pattern Dump to an existing project:
+
+```bash
+npm install --save-dev pattern-dump@alpha
+npx pd init
+```
+
+`pd init` writes a config, a patterns and styles tree, light and dark themes, a TypeScript setup and a
+few starter components, and adds `dev`, `audit`, `typecheck` and `build:scripts` scripts. It never
+overwrites an existing file.
+
+## Commands
+
+| Command | What it does |
+|---|---|
+| `pd init [dir]` | Set up a project |
+| `pd dev` | Start the workbench with live reload |
+| `pd audit` | Report defects across every component (`--format md`, `text` or `json`) |
+| `pd build` | Write the workbench as a static site for any host |
+| `pd export` | Rewrite near-duplicate component copies as one base with variants |
+| `pd help [command]` | Show options |
+
+## Configuration
+
+```ts
+// pattern-dump.config.ts
+import { defineConfig } from "pattern-dump";
+
+export default defineConfig({
+  sourceDir: "./src",
+  patternsDir: "./src/patterns",
+  outDir: "./dist",
+  styles: { strategy: "parallel", dir: "./src/styles" },
+  themes: { dir: "./themes", default: "light" },
+  assets: { strategy: "central", dir: "./assets" },
+  scriptsDir: "./src/scripts",
+});
+```
+
+## Features
+
+- **Live workbench:** every component and variant, with themes, viewport sizes, colour-vision simulation
+  and reload on save.
+- **Docs next to the code:** Markdown docs with live examples and source rendered from the component.
+- **Relationships:** which components each one uses and is used by, including borrowed CSS classes.
+- **Checks:** render errors, schema mismatches, HTML validation and accessibility findings, per component
+  and across the whole design system.
+- **Static publishing:** the whole workbench as plain files.
+- **Pattern packages:** use a design system from npm next to your own components.
+
+## Documentation
+
+- [Getting started](https://github.com/n8design/pattern-dump/blob/main/docs/guide/getting-started.md)
+- [Authoring components](https://github.com/n8design/pattern-dump/blob/main/docs/guide/authoring.md)
+- [Configuration](https://github.com/n8design/pattern-dump/blob/main/docs/guide/configuration.md)
+- [Themes](https://github.com/n8design/pattern-dump/blob/main/docs/guide/themes.md)
+- [Pattern packages](https://github.com/n8design/pattern-dump/blob/main/docs/guide/pattern-packages.md)
+- [Static build](https://github.com/n8design/pattern-dump/blob/main/docs/guide/static-build.md)
+- [Command line](https://github.com/n8design/pattern-dump/blob/main/docs/guide/cli.md)
+
+## Support
+
+- Bugs and feature requests: [GitHub issues](https://github.com/n8design/pattern-dump/issues)
+- Sponsor the work: [Stefan Bauer](https://github.com/sponsors/stfbauer) ·
+  [n8design](https://github.com/sponsors/n8design)
+
+## License
+
+[MIT](https://github.com/n8design/pattern-dump/blob/main/LICENSE) © 2026 [n8d](https://n8d.at) and contributors