Skip to content

Commit adde617

Browse files
committed
docs: add readme to uniwind package
1 parent 1ff4780 commit adde617

2 files changed

Lines changed: 46 additions & 1 deletion

File tree

packages/uniwind/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@
6565
"metro",
6666
"uniwind.css",
6767
"types.d.ts",
68-
"README.md"
68+
"readme.md"
6969
],
7070
"dependencies": {
7171
"@tailwindcss/node": "4.1.14",

packages/uniwind/readme.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
[<img alt="uniwind" src="assets/banner.png">](https://uniwind.dev/)
2+
3+
<div align="center">
4+
<p align="center">
5+
<a href="https://uniwind.dev/" target="_blank">
6+
<h1 align="center" style="color:red;">Uniwind</h1>
7+
<span>The fastest Tailwind bindings for React Native</span>
8+
</a>
9+
</p>
10+
</div>
11+
<br />
12+
13+
![npm version](https://img.shields.io/npm/v/uniwind?style=for-the-badge)
14+
[![npm downloads](https://img.shields.io/npm/dm/uniwind?style=for-the-badge)](https://www.npmjs.com/package/uniwind)
15+
[![npm downloads](https://img.shields.io/npm/dt/uniwind?style=for-the-badge)](https://www.npmjs.com/package/uniwind)
16+
[![License: MIT](https://img.shields.io/badge/License-MIT-44CD11.svg?style=for-the-badge)](https://opensource.org/licenses/MIT)
17+
18+
## Installation
19+
20+
```sh
21+
bun install uniwind@beta tailwindcss
22+
```
23+
24+
Then follow [installation guides](https://docs.uniwind.dev/quickstart)
25+
26+
## Documentation
27+
28+
- [Start here](https://docs.uniwind.dev/)
29+
- [Theming Basics](https://docs.uniwind.dev/theming/basics)
30+
- [Supported classNames](https://docs.uniwind.dev/class-names)
31+
- [Pro Version](https://docs.uniwind.dev/pro-version)
32+
33+
## Features
34+
35+
- ⚛️ Out‑of‑the‑box `className` bindings for every React Native component
36+
- ⚡ Styles are computed at build time for maximum performance
37+
- 🌙 Dark mode and 🎨 fully customizable themes
38+
- 🧩 Pseudo‑classes support — `focus`, `active`, `disabled`, and more
39+
- 📱 Responsive design with media queries
40+
- 🧰 Use custom CSS properties directly in React Native
41+
- 🔥 And [much more](https://docs.uniwind.dev/api/use-uniwind)
42+
43+
## License
44+
45+
MIT

0 commit comments

Comments
 (0)