@cwcss/crosswind 0.1.5 → 0.2.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2024 Open Web Foundation
+
+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, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,52 @@
+# @cwcss/crosswind
+
+A performant Utility-First CSS framework, similar to Tailwind or UnoCSS. Built with TypeScript and optimized for Bun.
+
+## Installation
+
+```bash
+bun add @cwcss/crosswind
+```
+
+```bash
+npm install @cwcss/crosswind
+```
+
+## Usage
+
+```typescript
+import { build, scan, generate } from '@cwcss/crosswind'
+
+// Build CSS from your content files
+const result = await build({
+  content: ['./src/**/*.html', './src/**/*.tsx'],
+  output: './dist/styles.css',
+  minify: true,
+})
+```
+
+### CLI
+
+```bash
+# Run the crosswind CLI
+crosswind build
+crosswind build --watch
+crosswind build --minify
+```
+
+## Features
+
+- On-demand utility CSS generation
+- Tailwind-compatible utility classes
+- Built-in CSS minification
+- File watching for development
+- Configurable theme (colors, spacing, typography, etc.)
+- Variant support (hover, focus, dark mode, responsive, and more)
+- Custom rules and shortcuts
+- Preset system for extensibility
+- Bun plugin support
+- Cross-platform CLI binaries (Linux, macOS, Windows)
+
+## License
+
+MIT