From 8b63a76aebc262c5eb0e1361333f0a70c0c1b610 Mon Sep 17 00:00:00 2001
From: Iulian Meghea <iulian@plumelo.com>
Date: Wed, 29 Jul 2026 19:04:42 +0000
Subject: [PATCH] feat: add theming docs, lightningcss at-rules, and badges to
 README

- Add npm/CI/license badges
- Document @text and @heading custom at-rules with examples
- Add Customization section covering typography, headings, layout,
  colors, and breakpoints CSS variables
- Add Contributing section with setup and release info
---
 README.md | 104 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 104 insertions(+)

diff --git a/README.md b/README.md
index abdf0cd..f40e6df 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,9 @@
 # @plumelo/titled
 
+[![npm version](https://img.shields.io/npm/v/@plumelo/titled.svg)](https://www.npmjs.com/package/@plumelo/titled)
+[![CI](https://github.com/plumelo/titled/actions/workflows/ci.yml/badge.svg)](https://github.com/plumelo/titled/actions/workflows/ci.yml)
+[![License](https://img.shields.io/npm/l/@plumelo/titled.svg)](./LICENSE)
+
 A simple collection of CSS utilities and mixins, built for use with [lightningcss](https://lightningcss.dev/).
 
 ## Install
@@ -37,6 +41,106 @@ Or import individual modules:
 | `@plumelo/titled/media` | Custom media query (`--mobile`) |
 | `@plumelo/titled/lightning` | Lightningcss custom at-rules (`@text`, `@heading`) |
 
+## Lightningcss custom at-rules
+
+The `@plumelo/titled/lightning` export provides two custom at-rules for lightningcss:
+
+### `@text`
+
+Applies font-size and line-height from the typography scale:
+
+```css
+@text md;
+/* -> font-size: var(--md-size); line-height: var(--md-lh); */
+```
+
+### `@heading`
+
+Applies font-size, line-height, letter-spacing, and font-weight for headings:
+
+```css
+@heading xl;
+/* -> font-size: var(--h-xl-size); line-height: var(--h-xl-lh);
+      letter-spacing: var(--h-xl-ls); font-weight: 600; */
+```
+
+## Customization
+
+All styles are driven by CSS custom properties. Override them in your own stylesheet to customize the theme:
+
+### Typography
+
+```css
+:root {
+  --xl-size: 20px;
+  --xl-lh: 1.5;
+  --lg-size: 18px;
+  --lg-lh: 28px;
+  --md-size: 16px;
+  --md-lh: 1.5;
+  --sm-size: 14px;
+  --sm-lh: 20px;
+}
+```
+
+### Headings
+
+```css
+:root {
+  --h-xl-size: 60px;
+  --h-xl-lh: 72px;
+  --h-xl-ls: -0.02em;
+  --h-lg-size: 48px;
+  --h-lg-lh: 60px;
+  --h-lg-ls: -0.02em;
+  --h-md-size: 36px;
+  --h-md-lh: 44px;
+  --h-md-ls: -0.02em;
+  --h-sm-size: 30px;
+  --h-sm-lh: 38px;
+  --h-xs-size: 24px;
+  --h-xs-lh: 32px;
+}
+```
+
+### Layout
+
+```css
+:root {
+  --row-base: 1280px;
+  --row-margin: 32px;
+  /* --row-width is computed: min(100vw, --row-base) - 2 * --row-margin */
+}
+```
+
+### Colors
+
+The component styles reference color tokens (e.g. `--primary-600`, `--gray-700`, `--error-300`) that you define in your own design system. Override `--color` and `--link-color` in `:root` to change the base text and link colors:
+
+```css
+:root {
+  --color: var(--gray-600);
+  --link-color: var(--primary-700);
+}
+```
+
+### Breakpoints
+
+```css
+/* Defined in @plumelo/titled/media */
+@custom-media --mobile (width < 768px);
+```
+
+## Contributing
+
+```sh
+git clone https://github.com/plumelo/titled.git
+cd titled
+npm install
+```
+
+Commits follow [Conventional Commits](https://www.conventionalcommits.org/). Releases are automated via [semantic-release](https://github.com/semantic-release/semantic-release) with npm trusted publishing (OIDC).
+
 ## License
 
 [WTFPL](./LICENSE)
\ No newline at end of file