Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nakzyu committed May 21, 2024
1 parent dcafd7d commit d7ba2b5
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 9 deletions.
24 changes: 16 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,24 @@
<h1 align="center">
<h3 align="center">
Headlessui React Native
</h1>
</h3>

This is an unstyled, accessible headless UI library for React Native.
<p align="center">This is an unstyled, accessible headless UI library for React Native. If you have nativewind installed, you can also use tailwind.
</p>

If you have nativewind installed, you can also use tailwind. Visit following website to see the full API documentation https://headlessui-react-native.vercel.app
<p align="center">
<a href="https://www.npmjs.com/package/headlessui-react-native"><img src="https://img.shields.io/npm/dt/headlessui-react-native" alt="Total Downloads"></a>
<a href="https://github.com/jamsubu/headlessui-react-native/tree/main/packages/headlessui-react-native"><img src="https://img.shields.io/npm/v/headlessui-react-native" alt="Latest Release"></a>
</p>

## Package
## Installation

| Name | Version | Downloads |
| :------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------: |
| [`headlessui-react-native`](https://github.com/jamsubu/headlessui-react-native/tree/main/packages/headlessui-react-native) | [![npm version](https://img.shields.io/npm/v/headlessui-react-native)](https://www.npmjs.com/package/headlessui-react-native) | [![npm downloads](https://img.shields.io/npm/dt/headlessui-react-native)](https://www.npmjs.com/package/headlessui-react-native) |
```sh
npm install headlessui-react-native
```

## Documentation

Visit following website to see the full API documentation https://headlessui-react-native.vercel.app

## Goals

Expand Down
2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
{
"name": "headlessui-react-native-monorepo",
"private": true,
"repository": "https://github.com/jamsubu/headlessui-react-native",
"license": "MIT",
"scripts": {
"dev": "turbo dev",
"lint": "turbo lint"
Expand Down
2 changes: 1 addition & 1 deletion packages/headlessui-react-native/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "headlessui-react-native",
"title": "HeadlessUI React Native",
"version": "1.1.2",
"version": "1.1.3",
"main": "dist/src/index.js",
"types": "dist/src/index.d.ts",
"homepage": "https://headlessui-react-native.vercel.app",
Expand Down

0 comments on commit d7ba2b5

Please sign in to comment.