Skip to content

Commit e63edb2

Browse files
committed
update some text
1 parent 3334dbb commit e63edb2

File tree

2 files changed

+25
-15
lines changed

2 files changed

+25
-15
lines changed

README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,25 @@
11
# WindCtrl
22

3-
> Next-generation styling library for Tailwind CSS
3+
> Advanced variant API for Tailwind CSS with stackable traits and interpolated dynamic styles.
44
5-
WindCtrl is a powerful styling library that evolves the concept of Variant APIs (like CVA) by introducing **Traits** for composable states and **Interpolated Variants** for dynamic values, all while maintaining a zero-runtime-dependency philosophy for style injection.
5+
**WindCtrl** is a next-generation styling utility that unifies static Tailwind classes and dynamic inline styles into a single, type-safe interface.
6+
7+
It evolves the concept of Variant APIs (like [cva](https://cva.style/)) by introducing **Stackable Traits** to solve combinatorial explosion and **Interpolated Variants** for seamless dynamic value handling—all while maintaining a minimal runtime footprint optimized for Tailwind's JIT compiler.
68

79
## Features
810

9-
- 🎨 **Unified API** - Hides the distinction between static Tailwind classes and dynamic inline styles
10-
- 🧩 **Trait System** - Solves combinatorial explosion by treating states as stackable, non-exclusive layers
11-
- 🎯 **Scoped Styling** - Context-aware styling without React Context (RSC friendly)
12-
- 🔒 **Type-Safe** - Full TypeScript support with intelligent type inference
13-
- 📦 **Zero Runtime** - Minimal bundle size with only `clsx` and `tailwind-merge` as dependencies
14-
-**Performance** - Optimized for render performance
11+
- 🎨 **Unified API** - Seamlessly blends static Tailwind classes and dynamic inline styles into one cohesive interface.
12+
- 🧩 **Trait System** - Solves combinatorial explosion by treating states as stackable, non-exclusive layers.
13+
- 🎯 **Scoped Styling** - Context-aware styling using data attributes - no React Context required (RSC friendly).
14+
-**JIT Optimized** - Prevents CSS bundle bloat by intelligently routing arbitrary values to inline styles.
15+
- 🔒 **Type-Safe** - Best-in-class TypeScript support with automatic prop inference.
16+
- 📦 **Minimal Overhead** - Ultra-lightweight runtime with only `clsx` and `tailwind-merge` as dependencies.
17+
18+
## Installation
19+
20+
```bash
21+
npm install windctrl
22+
```
1523

1624
## Quick Start
1725

package.json

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"name": "windctrl",
33
"version": "0.0.1",
4-
"description": "Next-generation styling library for Tailwind CSS",
4+
"description": "Advanced variant API for Tailwind CSS with stackable traits and interpolated dynamic styles.",
55
"license": "MIT",
6-
"author": "Masaki Morishita",
6+
"author": "Masaki Morishita (@morishxt)",
77
"type": "module",
88
"main": "./dist/index.js",
99
"types": "./dist/index.d.ts",
@@ -22,13 +22,15 @@
2222
"keywords": [
2323
"tailwind",
2424
"tailwindcss",
25-
"styling",
26-
"css",
2725
"variants",
2826
"cva",
29-
"class-variance-authority",
30-
"react",
31-
"typescript"
27+
"styling",
28+
"clsx",
29+
"tailwind-merge",
30+
"rsc",
31+
"css-in-js",
32+
"traits",
33+
"interpolation"
3234
],
3335
"repository": {
3436
"type": "git",

0 commit comments

Comments
 (0)