Skip to content

Commit 00549d3

Browse files
committed
docs: uniwind readme
1 parent 89b1a6c commit 00549d3

3 files changed

Lines changed: 74 additions & 5 deletions

File tree

LICENSE

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Uniwind
4+
Permission is hereby granted, free of charge, to any person obtaining a copy
5+
of this software and associated documentation files (the "Software"), to deal
6+
in the Software without restriction, including without limitation the rights
7+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8+
copies of the Software, and to permit persons to whom the Software is
9+
furnished to do so, subject to the following conditions:
10+
11+
The above copyright notice and this permission notice shall be included in all
12+
copies or substantial portions of the Software.
13+
14+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20+
SOFTWARE.

packages/uniwind/package.json

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"name": "uniwind",
44
"version": "1.0.0-beta.5",
55
"description": "The fastest Tailwind bindings for React Native",
6-
"homepage": "https://github.com/Unistyles-OSS/uniwind",
6+
"homepage": "https://uniwind.dev",
77
"author": "UnistylesOSS",
88
"type": "module",
99
"repository": "https://github.com/Unistyles-OSS/uniwind",
@@ -19,6 +19,18 @@
1919
"build:css": "bun run src/css/index.ts",
2020
"test": "bun test"
2121
},
22+
"keywords": [
23+
"unistyles",
24+
"react-native-unistyles",
25+
"react-native",
26+
"react",
27+
"native",
28+
"tailwind",
29+
"tailwindcss",
30+
"theme",
31+
"style"
32+
],
33+
"license": "MIT",
2234
"style": "./uniwind.css",
2335
"source": "src/index",
2436
"exports": {

readme.md

Lines changed: 41 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,43 @@
1-
# uniwind
1+
<div align="center">
2+
<p align="center">
3+
<a href="https://uniwind.dev/" target="_blank">
4+
<h1 align="center" style="color:red;">Uniwind</h1>
5+
<span>The fastest Tailwind bindings for React Native</span>
6+
</a>
7+
</p>
8+
</div>
9+
<br />
210

3-
```bash
4-
bun install
5-
bun run build
11+
![GitHub package.json version](https://img.shields.io/github/package-json/v/unistyles-oss/uniwind?style=for-the-badge)
12+
[![npm downloads](https://img.shields.io/npm/dm/uniwind?style=for-the-badge)](https://www.npmjs.com/package/uniwind)
13+
[![npm downloads](https://img.shields.io/npm/dt/uniwind?style=for-the-badge)](https://www.npmjs.com/package/uniwind)
14+
[![License: MIT](https://img.shields.io/badge/License-MIT-44CD11.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)
15+
16+
## Installation
17+
18+
```sh
19+
bun install uniwind tailwindcss
620
```
21+
22+
Then follow [installation guides](https://docs.uniwind.dev/quickstart)
23+
24+
## Documentation
25+
26+
- [Start here](https://docs.uniwind.dev/quickstart)
27+
- [Pro Version](https://docs.uniwind.dev/pro-version)
28+
- [Supported classNames](https://docs.uniwind.dev/class-names)
29+
- [Theming Basics](https://docs.uniwind.dev/theming/basics)
30+
31+
## Features
32+
33+
- ⚛️ Out‑of‑the‑box `className` bindings for every React Native component
34+
- ⚡ Styles are computed at build time for maximum performance
35+
- 🌙 Dark mode and 🎨 fully customizable themes
36+
- 🧩 Pseudo‑classes support — `focus`, `active`, `disabled`, and more
37+
- 📱 Responsive design with media queries
38+
- 🧰 Use custom CSS properties directly in React Native
39+
- 🔥 And [much more](https://docs.uniwind.dev/api/use-uniwind)
40+
41+
## License
42+
43+
MIT

0 commit comments

Comments
 (0)