Skip to content

Commit c1d2a5b

Browse files
committed
update README
1 parent c410450 commit c1d2a5b

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

README.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,29 @@ Crafted with [NativeWind v4](https://www.nativewind.dev/) and accessibility in m
88

99
https://github.com/mrzachnugent/react-native-reusables/assets/63797719/ae7e074f-05a4-4568-b71a-f1e0be13650d
1010

11-
### Get started with our [📖 Docs](https://rnr-docs.vercel.app/getting-started/initial-setup/) or checkout the [🌐 web demo](https://rnr-showcase.vercel.app/)
11+
[📖 Docs](https://rnr-docs.vercel.app/)
12+
<br/>
13+
[🌐 Web demo](https://rnr-showcase.vercel.app/)
1214

1315
### How to use
1416

15-
1. Follow our [documentation](https://rnr-docs.vercel.app/getting-started/initial-setup/) to get started with a template or with a manual configuration.
17+
**Init**
1618

17-
2. Browse our [components](https://rnr-docs.vercel.app/components/accordion/) and use the CLI to add the components to your project
19+
Quickly create a new project using the React Native Reusables CLI.
20+
21+
> If a `package.json` is detected, the CLI will install all necessary dependencies and automatically configure your project for you.
22+
23+
```bash
24+
npx @react-native-reusables/cli@latest init
25+
```
26+
27+
**Add**
28+
29+
Add components to an existing project using the React Native Reusables CLI.
30+
31+
```bash
32+
npx @react-native-reusables/cli@latest add
33+
```
1834

1935
#### Upcoming components
2036

@@ -28,9 +44,9 @@ https://github.com/mrzachnugent/react-native-reusables/assets/63797719/ae7e074f-
2844

2945
This project includes only components built without third-party libraries or those that use [@rn-primitives](https://rnprimitives.com) _(universal radix-ui/primitives)_.
3046

31-
### Excluded components
47+
**Excluded components**
3248

33-
Only **14 out of the 50** shadcn/ui components are excluded from this library. However, you can use the following packages or repositories to build your own
49+
Only **14 out of the 51** shadcn/ui components are excluded from this library. However, you can use the following packages or repositories to build your own
3450

3551
#### Calendar
3652

0 commit comments

Comments
 (0)