Skip to content

Commit e8abd7b

Browse files
chore: wip
1 parent 1734035 commit e8abd7b

File tree

3 files changed

+136
-0
lines changed

3 files changed

+136
-0
lines changed

packages/crosswind/README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# @cwcss/crosswind
2+
3+
A performant Utility-First CSS framework, similar to Tailwind or UnoCSS. Built with TypeScript and optimized for Bun.
4+
5+
## Installation
6+
7+
```bash
8+
bun add @cwcss/crosswind
9+
```
10+
11+
```bash
12+
npm install @cwcss/crosswind
13+
```
14+
15+
## Usage
16+
17+
```typescript
18+
import { build, scan, generate } from '@cwcss/crosswind'
19+
20+
// Build CSS from your content files
21+
const result = await build({
22+
content: ['./src/**/*.html', './src/**/*.tsx'],
23+
output: './dist/styles.css',
24+
minify: true,
25+
})
26+
```
27+
28+
### CLI
29+
30+
```bash
31+
# Run the crosswind CLI
32+
crosswind build
33+
crosswind build --watch
34+
crosswind build --minify
35+
```
36+
37+
## Features
38+
39+
- On-demand utility CSS generation
40+
- Tailwind-compatible utility classes
41+
- Built-in CSS minification
42+
- File watching for development
43+
- Configurable theme (colors, spacing, typography, etc.)
44+
- Variant support (hover, focus, dark mode, responsive, and more)
45+
- Custom rules and shortcuts
46+
- Preset system for extensibility
47+
- Bun plugin support
48+
- Cross-platform CLI binaries (Linux, macOS, Windows)
49+
50+
## License
51+
52+
MIT

packages/headwind/README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# headwind
2+
3+
The core CSS engine powering the Crosswind framework. Headwind handles parsing, rule generation, scanning, and CSS output for utility-first CSS classes.
4+
5+
## Installation
6+
7+
```bash
8+
bun add headwind
9+
```
10+
11+
```bash
12+
npm install headwind
13+
```
14+
15+
## Usage
16+
17+
```typescript
18+
import { build, buildAndWrite } from 'headwind'
19+
import { config } from 'headwind'
20+
21+
// Build CSS from content patterns
22+
const result = await buildAndWrite({
23+
...config,
24+
content: ['./src/**/*.html'],
25+
output: './dist/styles.css',
26+
minify: true,
27+
})
28+
29+
console.log(`Generated ${result.classes.size} classes in ${result.duration}ms`)
30+
```
31+
32+
### Using as a Bun Plugin
33+
34+
```typescript
35+
import { plugin } from 'headwind'
36+
37+
await Bun.build({
38+
entrypoints: ['./src/index.ts'],
39+
outdir: './dist',
40+
plugins: [plugin()],
41+
})
42+
```
43+
44+
## Features
45+
46+
- Utility class parsing and CSS generation
47+
- Configurable theme (colors, spacing, fonts, breakpoints, etc.)
48+
- Variant support (responsive, hover, focus, dark mode, and many more)
49+
- Preflight / CSS reset styles
50+
- Custom rules and shortcuts
51+
- Preset system
52+
- Compile class transformer
53+
- Attributify mode
54+
- Bracket syntax support
55+
- File scanning and transformation
56+
- Bun plugin integration
57+
58+
## License
59+
60+
MIT

packages/vscode/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# crosswind-vscode
2+
3+
A Visual Studio Code extension for the Crosswind CSS framework. Provides editor integration for an enhanced development experience.
4+
5+
## Installation
6+
7+
Install from the VS Code Marketplace by searching for **crosswind-vscode**, or install via the command line:
8+
9+
```bash
10+
code --install-extension crosswind-vscode
11+
```
12+
13+
## Usage
14+
15+
Once installed, the extension activates automatically in projects using Crosswind. It provides utility class support directly in your editor.
16+
17+
## Features
18+
19+
- Crosswind utility class support within VS Code
20+
- Seamless integration with the Crosswind CSS framework
21+
22+
## License
23+
24+
MIT

0 commit comments

Comments
 (0)