Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kanzitelli committed Oct 28, 2021
1 parent 0ada6e4 commit 33ccc6a
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@

Purpose of [RNN Screens](https://github.com/kanzitelli/rnn-screens) is to simplify and accelerate the process of React Native App development with [React Native Navigation](https://github.com/wix/react-native-navigation). It is not a replacement for RNN but a good addition!

### Quick start
## Quick start

Make sure you have [react-native-navigation](https://github.com/wix/react-native-navigation) installed in your project.

```
yarn add rnn-screens
```

### Usage
## Usage

#### 1. Describe app's screens
### 1. Describe app's screens

```tsx
import {generateRNNScreens, Root, Stack, Component, BottomTabs} from 'rnn-screens';
Expand Down Expand Up @@ -43,7 +43,7 @@ export const screens = generateRNNScreens<'Main' | 'Settings'>({
});
```

#### 2. Set app's navigation root
### 2. Set app's navigation root

```tsx
// One screen app
Expand All @@ -60,7 +60,7 @@ screens.N.setRoot(
);
```

#### 3. Navigate with predictability
### 3. Navigate with predictability

```tsx
// push screen
Expand All @@ -79,10 +79,10 @@ screens.push<ExampleScreenProps>(

An integration example could be found at [kanzitelli/rnn-starter](https://github.com/kanzitelli/rnn-starter).

### Credits
## Credits

Thanks to the team @ Wix behind [React Native Navigation](https://github.com/wix/react-native-navigation)!

### License
## License

This project is [MIT licensed](https://github.com/kanzitelli/rnn-screens/blob/master/LICENSE.md)

0 comments on commit 33ccc6a

Please sign in to comment.