Skip to content
This repository was archived by the owner on Dec 9, 2025. It is now read-only.

Commit 0e8f913

Browse files
authored
chore: add example instructions
1 parent 08bc999 commit 0e8f913

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,33 @@ const resultFromUri = await MlkitOcr.detectFromUri(uri);
1919
const resultFromFile = await MlkitOcr.detectFromFile(path);
2020
```
2121

22+
23+
## Example
24+
25+
To get started with the project, run `yarn bootstrap` in the root directory to install the required dependencies for each package:
26+
27+
```sh
28+
yarn bootstrap
29+
```
30+
31+
To start the packager:
32+
33+
```sh
34+
yarn example start
35+
```
36+
37+
To run the example app on Android:
38+
39+
```sh
40+
yarn example android
41+
```
42+
43+
To run the example app on iOS:
44+
45+
```sh
46+
yarn example ios
47+
```
48+
2249
## Contributing
2350

2451
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

0 commit comments

Comments
 (0)