diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 00000000..1250961e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,83 @@ +name: Bug report +description: Report an issue with uniwind +labels: Needs review +body: + - type: markdown + attributes: + value: | + ## Required Information + + - type: textarea + id: description + attributes: + label: What happened? + 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. + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to Reproduce + description: Provide a detailed list of steps to reproduce the issue. + placeholder: | + 1. + 2. + 3. + validations: + required: true + + - type: input + id: repro + attributes: + label: Snack or Repository Link (Optional) + description: Provide a link to a GitHub repository or Snack that reproduces the issue. + placeholder: Issues without a reproduction may be marked as stale. + + - type: input + id: uniwind-version + attributes: + label: Uniwind Version + description: Which version of `uniwind` are you using? + placeholder: 1.0.0 + validations: + required: true + + - type: input + id: react-native-version + attributes: + label: React Native Version + description: Which version of React Native are you using? + placeholder: 0.78.0 + validations: + required: true + + - type: dropdown + id: platforms + attributes: + label: Platforms + description: Which platforms does the issue occur on? (Select all that apply.) + multiple: true + options: + - Android + - iOS + - Web + validations: + required: true + + - type: dropdown + id: expo + attributes: + label: Expo + description: Are you using Expo? + options: + - 'Yes' + - 'No' + + - type: checkboxes + attributes: + label: Additional information + description: Please check all the boxes that apply + options: + - label: I've searched for [similar issues in this repository](https://github.com/Unistyles-OSS/uniwind/issues) and found none + required: true diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..09599be6 --- /dev/null +++ b/LICENSE @@ -0,0 +1,20 @@ +MIT License + +Copyright (c) 2025 Uniwind +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. \ No newline at end of file diff --git a/assets/banner.png b/assets/banner.png new file mode 100644 index 00000000..5be5a491 Binary files /dev/null and b/assets/banner.png differ diff --git a/packages/uniwind/package.json b/packages/uniwind/package.json index ac9e2b40..f182c78d 100644 --- a/packages/uniwind/package.json +++ b/packages/uniwind/package.json @@ -3,7 +3,7 @@ "name": "uniwind", "version": "1.0.0-beta.5", "description": "The fastest Tailwind bindings for React Native", - "homepage": "https://github.com/Unistyles-OSS/uniwind", + "homepage": "https://uniwind.dev", "author": "UnistylesOSS", "type": "module", "repository": "https://github.com/Unistyles-OSS/uniwind", @@ -19,6 +19,18 @@ "build:css": "bun run src/css/index.ts", "test": "bun test" }, + "keywords": [ + "unistyles", + "react-native-unistyles", + "react-native", + "react", + "native", + "tailwind", + "tailwindcss", + "theme", + "style" + ], + "license": "MIT", "style": "./uniwind.css", "source": "src/index", "exports": { diff --git a/readme.md b/readme.md index 377e334c..1343c69d 100644 --- a/readme.md +++ b/readme.md @@ -1,6 +1,45 @@ -# uniwind +[uniwind](https://uniwind.dev/) -```bash -bun install -bun run build +
+

+ +

Uniwind

+ The fastest Tailwind bindings for React Native + +

+
+
+ +![npm version](https://img.shields.io/npm/v/uniwind?style=for-the-badge) +[![npm downloads](https://img.shields.io/npm/dm/uniwind?style=for-the-badge)](https://www.npmjs.com/package/uniwind) +[![npm downloads](https://img.shields.io/npm/dt/uniwind?style=for-the-badge)](https://www.npmjs.com/package/uniwind) +[![License: MIT](https://img.shields.io/badge/License-MIT-44CD11.svg?style=for-the-badge)](https://opensource.org/licenses/MIT) + +## Installation + +```sh +bun install uniwind@beta tailwindcss ``` + +Then follow [installation guides](https://docs.uniwind.dev/quickstart) + +## Documentation + +- [Start here](https://docs.uniwind.dev/) +- [Theming Basics](https://docs.uniwind.dev/theming/basics) +- [Supported classNames](https://docs.uniwind.dev/class-names) +- [Pro Version](https://docs.uniwind.dev/pro-version) + +## Features + +- ⚛️ Out‑of‑the‑box `className` bindings for every React Native component +- ⚡ Styles are computed at build time for maximum performance +- 🌙 Dark mode and 🎨 fully customizable themes +- 🧩 Pseudo‑classes support — `focus`, `active`, `disabled`, and more +- 📱 Responsive design with media queries +- 🧰 Use custom CSS properties directly in React Native +- 🔥 And [much more](https://docs.uniwind.dev/api/use-uniwind) + +## License + +MIT