Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jamsch committed Oct 14, 2024
1 parent 4e74261 commit 6068932
Showing 1 changed file with 3 additions and 13 deletions.
16 changes: 3 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,6 @@ Hanzi/Kanji writer and stroke order quizzer library for React Native, based on t

![preview](https://i.imgur.com/5EkOdbR.gif)

## Prerequisites

Make sure you have the following packages installed in your project before continuing:

- react-native-gesture-handler v2+
- react-native-reanimated v3+
- react-native-svg v15+

## Installation

```sh
Expand All @@ -28,6 +20,9 @@ npm install @jamsch/react-native-hanzi-writer

## Basic Usage

> [!IMPORTANT]
> Make sure your entire application is wrapped in a `<GestureHandlerRootView>` element for gestures to work in quiz mode. Also make sure that the order of the elements inside `<HanziWriter.Svg>` match the above example as it affects the display layering. That being said, you still can conditionally render these components.
```tsx
import { Button, Text, View } from 'react-native';
import { GestureHandlerRootView } from 'react-native-gesture-handler';
Expand Down Expand Up @@ -80,11 +75,6 @@ function App() {
}
```

> **Important Notes**
>
> - Make sure your entire application is wrapped in a `<GestureHandlerRootView>` element for gestures to work in quiz mode.
> - Make sure that the order of the elements inside `<HanziWriter.Svg>` match the above example as it affects the display layering. That being said, you still can conditionally render these components.
## Starting the quiz

You can start the quiz by calling `writer.quiz.start()`.
Expand Down

0 comments on commit 6068932

Please sign in to comment.