Skip to content

Commit 3969cb5

Browse files
committed
chore: 📝 updated README.md
1 parent 65b6d54 commit 3969cb5

File tree

1 file changed

+37
-7
lines changed

1 file changed

+37
-7
lines changed

README.md

Lines changed: 37 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,50 @@
1-
# AdaptUI React Native Tailwind
1+
<h1 align="center">AdaptUI React Native Tailwind</h1>
2+
3+
<p align="center">
4+
Collection of components that are accessible, composable, customizable from low level to build your own UI & Design System
5+
</p>
6+
7+
<p align="center">
8+
<a href="https://npmjs.org/package/@adaptui/react-native-tailwind"><img alt="NPM version" src="https://img.shields.io/npm/v/@adaptui/react-native-tailwind.svg" /></a>
9+
<a href="https://npmjs.org/package/@adaptui/react-native-tailwind"><img alt="NPM downloads" src="https://img.shields.io/npm/dm/@adaptui/react-native-tailwind.svg"></a>
10+
<a href="https://github.com/adaptui/react-native-tailwind/actions"><img alt="Build Status" src="https://github.com/adaptui/react-native-tailwind/workflows/Test/badge.svg?event=push&branch=master" /></a><br/>
11+
<a href="https://github.com/adaptui/react-native-tailwind/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License">
12+
</a>
13+
<a target="_blank" href="https://octo-repo-visualization.vercel.app/?repo=adaptui%2Freact-native-tailwind"><img src="https://img.shields.io/badge/Repo-Visualization-orange" alt="Repo Visualization">
14+
</a>
15+
</p>
16+
17+
## :rocket: Features
18+
19+
- Accessible :wheelchair:
20+
- Composable :toolbox:
21+
- Uses latest Reanimated & Gesture Handler :robot:
22+
- Easy To Customize, Styled by Tailwind & Extend :nail_care:
223

324
## Installation
425

526
```sh
27+
# npm
628
npm install @adaptui/react-native-tailwind
29+
30+
# Yarn
31+
yarn add @adaptui/react-native-tailwind
732
```
833

9-
## Usage
34+
> Make sure `React Native Reanimated` & `React Native Gesture Handler` is
35+
> installed
1036
11-
```js
12-
import { multiply } from "@adaptui/react-native-tailwind";
37+
## :beginner: Getting started
1338

14-
// ...
39+
Check out our [getting started docs](/docs/getting-started.md)
1540

16-
const result = await multiply(3, 7);
17-
```
41+
## 📑 Component Docs
42+
43+
- [Avatar](docs/avatar.md)
44+
45+
> **Note:** As the 0.#.# version number suggests that we are still very much
46+
> work in progress, so semantic versioning will not be followed until a v1
47+
> release. Expect breaking changes to occur on minor version jumps.
1848
1949
## Contributing
2050

0 commit comments

Comments
 (0)