Skip to content

Commit 1ff4780

Browse files
BrentlokBrentlok
authored
docs: readme (#53)
* docs: uniwind readme * docs: update npm version badge * docs: reorder documentation links * docs: add banner * docs: update start here link * docs: add issue template
1 parent 89b1a6c commit 1ff4780

5 files changed

Lines changed: 159 additions & 5 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug-report.yml‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
name: Bug report
2+
description: Report an issue with uniwind
3+
labels: Needs review
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## Required Information
9+
10+
- type: textarea
11+
id: description
12+
attributes:
13+
label: What happened?
14+
description: Provide a clear, concise, and descriptive explanation of the bug. Include screenshots or a video if needed by dragging and dropping them into the box below.
15+
validations:
16+
required: true
17+
18+
- type: textarea
19+
id: steps-to-reproduce
20+
attributes:
21+
label: Steps to Reproduce
22+
description: Provide a detailed list of steps to reproduce the issue.
23+
placeholder: |
24+
1.
25+
2.
26+
3.
27+
validations:
28+
required: true
29+
30+
- type: input
31+
id: repro
32+
attributes:
33+
label: Snack or Repository Link (Optional)
34+
description: Provide a link to a GitHub repository or Snack that reproduces the issue.
35+
placeholder: Issues without a reproduction may be marked as stale.
36+
37+
- type: input
38+
id: uniwind-version
39+
attributes:
40+
label: Uniwind Version
41+
description: Which version of `uniwind` are you using?
42+
placeholder: 1.0.0
43+
validations:
44+
required: true
45+
46+
- type: input
47+
id: react-native-version
48+
attributes:
49+
label: React Native Version
50+
description: Which version of React Native are you using?
51+
placeholder: 0.78.0
52+
validations:
53+
required: true
54+
55+
- type: dropdown
56+
id: platforms
57+
attributes:
58+
label: Platforms
59+
description: Which platforms does the issue occur on? (Select all that apply.)
60+
multiple: true
61+
options:
62+
- Android
63+
- iOS
64+
- Web
65+
validations:
66+
required: true
67+
68+
- type: dropdown
69+
id: expo
70+
attributes:
71+
label: Expo
72+
description: Are you using Expo?
73+
options:
74+
- 'Yes'
75+
- 'No'
76+
77+
- type: checkboxes
78+
attributes:
79+
label: Additional information
80+
description: Please check all the boxes that apply
81+
options:
82+
- label: I've searched for [similar issues in this repository](https://github.com/Unistyles-OSS/uniwind/issues) and found none
83+
required: true

‎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.

‎assets/banner.png‎

188 KB
Loading

‎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: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,45 @@
1-
# uniwind
1+
[<img alt="uniwind" src="assets/banner.png">](https://uniwind.dev/)
22

3-
```bash
4-
bun install
5-
bun run build
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
622
```
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)