Skip to content

Commit

Permalink
docs: updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
mfkrause committed Nov 21, 2024
1 parent db469f6 commit ac853ec
Showing 1 changed file with 28 additions and 3 deletions.
31 changes: 28 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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

Expand Down

0 comments on commit ac853ec

Please sign in to comment.