Skip to content

Commit 29acee0

Browse files
committed
docs: add Expo demo screenshot and installation guide
- Add screenshot showing FluidAudio working in Expo test app - Add Expo installation section to README - Update FluidAudio link to point to GitHub - Update CI to use macos-15 and iPhone 16 Pro simulator
1 parent d8fbfd3 commit 29acee0

3 files changed

Lines changed: 22 additions & 4 deletions

File tree

.github/workflows/ci.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ jobs:
4444
# Build iOS example app
4545
build-ios:
4646
name: Build iOS
47-
runs-on: macos-14
47+
runs-on: macos-15
4848
steps:
4949
- name: Checkout
5050
uses: actions/checkout@v4
@@ -74,7 +74,7 @@ jobs:
7474
-scheme FluidAudioExample \
7575
-configuration Debug \
7676
-sdk iphonesimulator \
77-
-destination 'platform=iOS Simulator,name=iPhone 15 Pro' \
77+
-destination 'platform=iOS Simulator,name=iPhone 16 Pro' \
7878
build \
7979
CODE_SIGNING_ALLOWED=NO
8080

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# react-native-fluidaudio
22

3-
React Native wrapper for [FluidAudio](../FluidAudio) - a Swift library for ASR, VAD, Speaker Diarization, and TTS on Apple platforms.
3+
React Native wrapper for [FluidAudio](https://github.com/FluidInference/FluidAudio) - a Swift library for ASR, VAD, Speaker Diarization, and TTS on Apple platforms.
4+
5+
<p align="center">
6+
<img src="docs/expo-demo.png" alt="FluidAudio Expo Demo" width="300">
7+
</p>
48

59
## Features
610

@@ -13,10 +17,12 @@ React Native wrapper for [FluidAudio](../FluidAudio) - a Swift library for ASR,
1317
## Requirements
1418

1519
- iOS 17.0+
16-
- React Native 0.71+
20+
- React Native 0.71+ or Expo SDK 50+
1721

1822
## Installation
1923

24+
### React Native CLI
25+
2026
```bash
2127
npm install react-native-fluidaudio
2228
```
@@ -33,6 +39,18 @@ Then install pods:
3339
cd ios && pod install
3440
```
3541

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

3856
### Basic Transcription

docs/expo-demo.png

94.1 KB
Loading

0 commit comments

Comments
 (0)