Skip to content

Commit 9849e91

Browse files
authored
chore: add info about expo managed projects to docs and readme (#254)
1 parent b77d9a2 commit 9849e91

File tree

3 files changed

+28
-14
lines changed

3 files changed

+28
-14
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,19 @@ allowing developers to generate and modify audio in exact same way it is possibl
1717
yarn add react-native-audio-api
1818
```
1919

20+
## Usage with expo
21+
22+
`react-native-audio-api` contains native custom code and isn't part of the Expo Go application. In order to be available in expo managed builds, you have to use Expo development build. Simplest way on starting local expo dev builds, is to use:
23+
24+
```bash
25+
# Build native iOS project
26+
npx expo run:ios
27+
# Build native Android project
28+
npx expo run:android
29+
```
30+
31+
To learn more about expo development builds, please check out [Development Builds Documentation](https://docs.expo.dev/develop/development-builds/introduction/).
32+
2033
## Documentation
2134

2235
`react-native-audio-api` tries to strictly follow the Web Audi API specification, which can be found at [https://www.w3.org/TR/webaudio/](https://www.w3.org/TR/webaudio/).
@@ -29,14 +42,6 @@ Our current coverage of Web Audio API specification can be found here: [Web Audi
2942

3043
## Examples
3144

32-
<div align="center">
33-
34-
<a href="https://www.youtube.com/watch?v=npALr9IIDkI" target="_blank" rel="noopener noreferrer">
35-
<img src="./docs/assets/rnaa-example-01-thumbnail.png" width="640" />
36-
</a>
37-
38-
</div>
39-
4045
The source code for the example application is under the [`/apps/common-app`](./apps/common-app/) directory. If you want to play with the API but don't feel like trying it on a real app, you can run the example project. Check [Example README](./apps/fabric-example/README.md) for installation instructions.
4146

4247
## Your feedback
-384 KB
Binary file not shown.

packages/audiodocs/docs/fundamentals/getting-started.mdx

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,24 @@ Install `react-native-audio-api` package from npm:
4141
</TabItem>
4242
</Tabs>
4343

44-
### Expo development build
44+
### Usage with expo
4545

46-
When using an [Expo development build](https://docs.expo.dev/develop/development-builds/introduction/), run prebuild to update the native code in the `ios` and `android` directories.
46+
`react-native-audio-api` contains native custom code and isn't part of the Expo Go application. In order to be available in expo managed builds, you have to use Expo development build. Simplest way on starting local expo dev builds, is to use:
4747

48-
```bash
49-
npx expo prebuild
50-
```
48+
<Tabs groupId="expoStart">
49+
<TabItem value="ios" label="iOS" default>
50+
51+
npx expo run:ios
52+
53+
</TabItem>
54+
<TabItem value="android" label="Android">
55+
56+
npx expo run:android
57+
58+
</TabItem>
59+
</Tabs>
5160

52-
### Platform specific setup
61+
To learn more about expo development builds, please check out [Development Builds Documentation](https://docs.expo.dev/develop/development-builds/introduction/).
5362

5463
#### Android
5564

0 commit comments

Comments
 (0)