@lukeashford/aurelius 2.8.0 → 2.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +24 -5
  2. package/llms.md +28 -4
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -55,11 +55,30 @@ while staying within design system constraints.
55
55
  ### 1. Install
56
56
 
57
57
  ```bash
58
+ # For Vite projects (Recommended)
58
59
  npm install @lukeashford/aurelius
59
- npm install -D tailwindcss postcss @tailwindcss/postcss eslint @typescript-eslint/parser eslint-plugin-better-tailwindcss @poupe/eslint-plugin-tailwindcss @eslint/css tailwind-csstree
60
+ npm install -D tailwindcss @tailwindcss/vite eslint @typescript-eslint/parser eslint-plugin-better-tailwindcss @poupe/eslint-plugin-tailwindcss @eslint/css tailwind-csstree
61
+
62
+ # For other projects
63
+ # npm install -D tailwindcss @tailwindcss/postcss postcss ...
64
+ ```
65
+
66
+ ### 2. Configure (Vite)
67
+
68
+ If you are using Vite, add the Tailwind CSS plugin to your `vite.config.ts`:
69
+
70
+ ```typescript
71
+ import {defineConfig} from 'vite'
72
+ import tailwindcss from '@tailwindcss/vite'
73
+
74
+ export default defineConfig({
75
+ plugins: [
76
+ tailwindcss(),
77
+ ],
78
+ })
60
79
  ```
61
80
 
62
- ### 2. Import the design system
81
+ ### 3. Import the design system
63
82
 
64
83
  Create or update your `index.css`:
65
84
 
@@ -78,7 +97,7 @@ Then import it in your entry file:
78
97
  import './index.css'
79
98
  ```
80
99
 
81
- ### 3. Configure ESLint (simplest form)
100
+ ### 4. Configure ESLint (simplest form)
82
101
 
83
102
  Aurelius ships with a default ESLint config you can re-export in one line. It enforces design system
84
103
  constraints — if ESLint complains, you're leaving the rails.
@@ -106,7 +125,7 @@ export default createAureliusESLintConfig({
106
125
  - **CSS files:** Tailwind v4 CSS best practices, valid `@apply` directives, no arbitrary value
107
126
  overuse, and proper theme token usage
108
127
 
109
- ### 4. Update package.json scripts
128
+ ### 5. Update package.json scripts
110
129
 
111
130
  Add a lint script and wire it into your workflow:
112
131
 
@@ -123,7 +142,7 @@ Add a lint script and wire it into your workflow:
123
142
  If your project already has CI (or you're asked to add one), include `npm run lint` in that
124
143
  pipeline so lint failures block merges.
125
144
 
126
- ### 5. Use components
145
+ ### 6. Use components
127
146
 
128
147
  ```tsx
129
148
  import {Button, Card, Input} from '@lukeashford/aurelius'
package/llms.md CHANGED
@@ -1,3 +1,8 @@
1
+ <!--
2
+ DO NOT EDIT THIS FILE DIRECTLY.
3
+ This file is auto-generated by scripts/generate-manifest.js.
4
+ -->
5
+
1
6
  # Aurelius Design System — AI Manifest
2
7
 
3
8
  ## Setup (Tailwind v4)
@@ -5,11 +10,30 @@
5
10
  ### 1. Install
6
11
 
7
12
  ```bash
13
+ # For Vite projects (Recommended)
8
14
  npm install @lukeashford/aurelius
9
- npm install -D tailwindcss postcss @tailwindcss/postcss eslint @typescript-eslint/parser eslint-plugin-better-tailwindcss @poupe/eslint-plugin-tailwindcss @eslint/css tailwind-csstree
15
+ npm install -D tailwindcss @tailwindcss/vite eslint @typescript-eslint/parser eslint-plugin-better-tailwindcss @poupe/eslint-plugin-tailwindcss @eslint/css tailwind-csstree
16
+
17
+ # For other projects (font bundling might not work)
18
+ npm install -D tailwindcss @tailwindcss/postcss postcss ...
19
+ ```
20
+
21
+ ### 2. Configure (Vite)
22
+
23
+ If using Vite, add the Tailwind CSS plugin to your `vite.config.ts`:
24
+
25
+ ```typescript
26
+ import { defineConfig } from 'vite'
27
+ import tailwindcss from '@tailwindcss/vite'
28
+
29
+ export default defineConfig({
30
+ plugins: [
31
+ tailwindcss(),
32
+ ],
33
+ })
10
34
  ```
11
35
 
12
- ### 2. Import the design system
36
+ ### 3. Import the design system
13
37
 
14
38
  Create or update your `index.css`:
15
39
 
@@ -28,7 +52,7 @@ Then import it in your entry file:
28
52
  import './index.css'
29
53
  ```
30
54
 
31
- ### 3. Configure ESLint
55
+ ### 4. Configure ESLint
32
56
 
33
57
  Aurelius ships with a default ESLint config you can re-export in one line. It enforces design system
34
58
  constraints — if ESLint complains, you're leaving the rails.
@@ -38,7 +62,7 @@ constraints — if ESLint complains, you're leaving the rails.
38
62
  export { default } from '@lukeashford/aurelius/eslint';
39
63
  ```
40
64
 
41
- ### 4. Add lint script and run it
65
+ ### 5. Add lint script and run it
42
66
 
43
67
  Add a lint script and wire it into your workflow:
44
68
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lukeashford/aurelius",
3
- "version": "2.8.0",
3
+ "version": "2.9.0",
4
4
  "description": "Design system for Aurelius applications — A cohesive visual language for creative technologists",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",