Skip to content

Commit 996a564

Browse files
authored
Merge pull request #2 from FluidInference/update-readme-expo-install
docs: simplify installation instructions for Expo
2 parents 6ab7e8f + 3c0b0da commit 996a564

1 file changed

Lines changed: 14 additions & 26 deletions

File tree

README.md

Lines changed: 14 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -24,42 +24,30 @@ React Native wrapper for [FluidAudio](https://github.com/FluidInference/FluidAud
2424

2525
## Installation
2626

27-
### React Native CLI
27+
### Expo (Recommended)
2828

2929
```bash
30-
npm install react-native-fluidaudio
30+
npm install @fluidinference/react-native-fluidaudio
31+
npx expo run:ios
3132
```
3233

33-
Add FluidAudio to your `ios/Podfile`:
34+
Expo automatically handles native dependencies - no manual pod install needed.
3435

35-
```ruby
36-
pod 'FluidAudio', :git => 'https://github.com/FluidInference/FluidAudio.git', :tag => 'v0.7.8'
37-
```
36+
> **Note:** Expo Go is not supported - native modules require a [development build](https://docs.expo.dev/develop/development-builds/introduction/).
3837
39-
Then install pods:
38+
### React Native CLI
4039

4140
```bash
41+
npm install @fluidinference/react-native-fluidaudio
4242
cd ios && pod install
4343
```
4444

45-
### Expo
46-
47-
For Expo projects, use a [development build](https://docs.expo.dev/develop/development-builds/introduction/):
48-
49-
```bash
50-
npx expo install react-native-fluidaudio
51-
npx expo prebuild
52-
npx expo run:ios
53-
```
54-
55-
> **Note:** Expo Go is not supported - native modules require a development build.
56-
5745
## Usage
5846

5947
### Basic Transcription
6048

6149
```typescript
62-
import { ASRManager, onModelLoadProgress } from 'react-native-fluidaudio';
50+
import { ASRManager, onModelLoadProgress } from '@fluidinference/react-native-fluidaudio';
6351

6452
// Monitor model loading progress
6553
const subscription = onModelLoadProgress((event) => {
@@ -83,7 +71,7 @@ subscription.remove();
8371
### Streaming Transcription
8472

8573
```typescript
86-
import { StreamingASRManager, onStreamingUpdate } from 'react-native-fluidaudio';
74+
import { StreamingASRManager, onStreamingUpdate } from '@fluidinference/react-native-fluidaudio';
8775

8876
const streaming = new StreamingASRManager();
8977

@@ -104,7 +92,7 @@ console.log('Final transcription:', result.text);
10492
### Voice Activity Detection
10593

10694
```typescript
107-
import { VADManager } from 'react-native-fluidaudio';
95+
import { VADManager } from '@fluidinference/react-native-fluidaudio';
10896

10997
const vad = new VADManager();
11098
await vad.initialize({ threshold: 0.85 });
@@ -122,7 +110,7 @@ segments.forEach((seg) => {
122110
### Speaker Diarization
123111

124112
```typescript
125-
import { DiarizationManager } from 'react-native-fluidaudio';
113+
import { DiarizationManager } from '@fluidinference/react-native-fluidaudio';
126114

127115
const diarizer = new DiarizationManager();
128116
await diarizer.initialize({
@@ -151,7 +139,7 @@ await diarizer.setKnownSpeakers([
151139
### Text-to-Speech
152140

153141
```typescript
154-
import { TTSManager } from 'react-native-fluidaudio';
142+
import { TTSManager } from '@fluidinference/react-native-fluidaudio';
155143

156144
const tts = new TTSManager();
157145
await tts.initialize({ variant: 'fiveSecond' });
@@ -168,7 +156,7 @@ await tts.synthesizeToFile('Hello, world!', '/path/to/output.wav');
168156
### System Information
169157

170158
```typescript
171-
import { getSystemInfo } from 'react-native-fluidaudio';
159+
import { getSystemInfo } from '@fluidinference/react-native-fluidaudio';
172160

173161
const info = await getSystemInfo();
174162
console.log(info.summary);
@@ -178,7 +166,7 @@ console.log(info.summary);
178166
### Cleanup
179167

180168
```typescript
181-
import { cleanup } from 'react-native-fluidaudio';
169+
import { cleanup } from '@fluidinference/react-native-fluidaudio';
182170

183171
// Clean up all resources when done
184172
await cleanup();

0 commit comments

Comments
 (0)