Skip to content

Commit

Permalink
docs: 📝 add getting-started file
Browse files Browse the repository at this point in the history
  • Loading branch information
Karthik-B-06 committed Jun 21, 2022
1 parent e1b1d1e commit 75c28d9
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Getting Started

Collection of components that are accessible, composable, customizable from low
level to build your own UI & Design System

## :rocket: Installation

```sh
# npm
npm install @adaptui/react-native-tailwind

# Yarn
yarn add @adaptui/react-native-tailwind
```

> Make sure
> `react react-native react-native-reanimated react-native-gesture-handler` is
> installed.
> Also make sure to wrap your App with `GestureHandlerRootView` from
> `react-native-gesture-handler`, and `TailwindThemeProvider` from
> `@adaptui/react-native-tailwind`
## Usage

Code below will render an [Avatar](./Avatar.md)

See [Avatar](./Avatar.md) docs for more info.

```jsx
import React from "react";
import { Avatar, useTheme } from "@adaptui/react-native-tailwind";

function AvatarComponentScreen() {
const tailwind = useTheme();

return (
<View
style={tailwind.style("flex-1 justify-center items-center bg-white-900")}
>
<Avatar style={tailwind.style("my-1")} />
</View>
);
}
```

## Component Docs

- [Avatar](avatar.md)
- [AvatarGroup](avatar-group.md)
- [Badge](badge.md)

0 comments on commit 75c28d9

Please sign in to comment.