diff --git a/README.md b/README.md index 9de8488..144090f 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,21 @@ -# ๐ŸŽค react-native-voicekit +# ๐ŸŽ™๏ธ react-native-voicekit -Recognize and transcribe user speech using React Native. +VoiceKit is a powerful speech recognition library for React Native that enables voice transcription across platforms. It provides direct access to native speech recognition APIs for optimal performance and aligns the API behavior between the different platforms. ![npm bundle size](https://img.shields.io/bundlephobia/min/react-native-voicekit?style=flat-square) ![GitHub](https://img.shields.io/github/license/kuatsu/react-native-voicekit?style=flat-square) ![GitHub last commit](https://img.shields.io/github/last-commit/kuatsu/react-native-voicekit?style=flat-square) > [!WARNING] > This project is still considered unstable and under active development. The API might change drastically in new versions. Please proceed with caution. +- โšก Real-time speech-to-text transcription +- ๐Ÿ“ฑ iOS and Android support using native speech recognition APIs +- ๐Ÿงช Fully compatible with Expo +- โšก iOS and Android APIs aligned for consistent behavior and superior developer experience +- ๐ŸŽ›๏ธ Single and continuous recognition modes +- ๐ŸŽจ Simple and intuitive React Hooks API +- ๐Ÿ’ช TypeScript support out of the box +- ๐Ÿ‘Œ Lightweight with zero dependencies + ## Installation ### React Native @@ -22,7 +31,23 @@ cd ios && pod install npx expo install react-native-voicekit ``` -Afterwards, add the config plugin to the `plugins` section of your `app.json` and `expo prebuild` or rebuild your development client. +Afterwards, add the config plugin to the `plugins` section of your `app.json`: + +```json +{ + "plugins": [ + [ + "react-native-voicekit", + { + "speechRecognitionPermission": "Custom iOS speech recognition permission message (optional)", + "microphonePermission": "Custom iOS microphone permission message (optional)" + } + ] + ] +} +``` + +Finally, `expo prebuild` or rebuild your development client. ## Quick Start