react-native-mlkit-ocr/README.md

Google on-device MLKit text recognition for React Native

# react-native-mlkit-ocr
<p align="center">
    Google on-device MLKit text recognition for React Native
</p>

<p align="center">
  <img src="https://user-images.githubusercontent.com/1637928/115913726-d2a97c00-a425-11eb-9c6a-6d19b974ee81.gif">
</p>


## Installation

```sh
npm install react-native-mlkit-ocr
```


## Usage

```js
import MlkitOcr from 'react-native-mlkit-ocr';

// ...

const resultFromUri = await MlkitOcr.detectFromUri(uri);
const resultFromFile = await MlkitOcr.detectFromFile(path);
```


## Example

To get started with the project, run `yarn bootstrap` in the root directory to install the required dependencies for each package:

```sh
yarn bootstrap
```

To start the packager:

```sh
yarn example start
```

To run the example app on Android:

```sh
yarn example android
```

To run the example app on iOS:

```sh
yarn example ios
```

## Contributing

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

## License

MIT