Skip to content

Commit 0a3f894

Browse files
committed
chore: readme fixes
1 parent 19f8cfc commit 0a3f894

File tree

2 files changed

+13
-76
lines changed

2 files changed

+13
-76
lines changed

README.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
<img src="./docs/assets/react-native-audio-api-gh-cover.png?v0.0.1" alt="React Native Audio API" width="100%">
22

3-
### ⚠️ Early version warning!
4-
5-
This library is at a very early stage of development. There are known performance issues and the library might not yet suitable for real production applications.
6-
73
### React Native Audio API
84

95
`react-native-audio-api` provides system for controlling audio in React Native environment compatible with Web Audio API specification,
@@ -41,7 +37,7 @@ Our current coverage of Web Audio API specification can be found here: [Web Audi
4137

4238
</div>
4339

44-
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/common-example/README.md) for installation instructions.
40+
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.
4541

4642
## Your feedback
4743

@@ -63,4 +59,4 @@ This project has been built and is maintained thanks to the support from [Softwa
6359

6460
## react-native-audio-api is created by Software Mansion
6561

66-
Since 2012 [Software Mansion](https://swmansion.com) is a software agency with experience in building web and mobile apps. We are Core React Native Contributors and experts in dealing with all kinds of React Native issues. We can help you build your next dream product – [Hire us](https://swmansion.com/contact/projects?utm_source=audioapid&utm_medium=readme).
62+
Since 2012 [Software Mansion](https://swmansion.com) is a software agency with experience in building web and mobile apps. We are Core React Native Contributors and experts in dealing with all kinds of React Native issues. We can help you build your next dream product – [Hire us](https://swmansion.com/contact/projects?utm_source=audioapi&utm_medium=readme).

apps/fabric-example/README.md

Lines changed: 11 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,20 @@
1-
This is a new [**React Native**](https://reactnative.dev) project, bootstrapped using [`@react-native-community/cli`](https://github.com/react-native-community/cli).
1+
# React Native Reanimated example app with Fabric
22

3-
# Getting Started
3+
## Installing & running application
44

5-
>**Note**: Make sure you have completed the [React Native - Environment Setup](https://reactnative.dev/docs/environment-setup) instructions till "Creating a new application" step, before proceeding.
5+
Before running application you need to install all dependencies. To do that:
66

7-
## Step 1: Start the Metro Server
7+
- In project's root directory run `yarn install`
8+
- In FabricExample directory run `yarn install`
89

9-
First, you will need to start **Metro**, the JavaScript _bundler_ that ships _with_ React Native.
10+
### Android
1011

11-
To start Metro, run the following command from the _root_ of your React Native project:
12+
To run this application on Android you need to have Java 17 active on your computer. You can check which version you are using by running `javac --version`. You can change it by changing `JAVA_HOME` environment variable or in Android Studio settings.
1213

13-
```bash
14-
# using npm
15-
npm start
14+
Then you can run this application by `yarn android` or from Android Studio.
1615

17-
# OR using Yarn
18-
yarn start
19-
```
16+
### iOS
2017

21-
## Step 2: Start your Application
18+
To run on iOS first go to `FabricExample/ios` and run `pod install`. This will install pods for Fabric architecture.
2219

23-
Let Metro Bundler run in its _own_ terminal. Open a _new_ terminal from the _root_ of your React Native project. Run the following command to start your _Android_ or _iOS_ app:
24-
25-
### For Android
26-
27-
```bash
28-
# using npm
29-
npm run android
30-
31-
# OR using Yarn
32-
yarn android
33-
```
34-
35-
### For iOS
36-
37-
```bash
38-
# using npm
39-
npm run ios
40-
41-
# OR using Yarn
42-
yarn ios
43-
```
44-
45-
If everything is set up _correctly_, you should see your new app running in your _Android Emulator_ or _iOS Simulator_ shortly provided you have set up your emulator/simulator correctly.
46-
47-
This is one way to run your app — you can also run it directly from within Android Studio and Xcode respectively.
48-
49-
## Step 3: Modifying your App
50-
51-
Now that you have successfully run the app, let's modify it.
52-
53-
1. Open `App.tsx` in your text editor of choice and edit some lines.
54-
2. For **Android**: Press the <kbd>R</kbd> key twice or select **"Reload"** from the **Developer Menu** (<kbd>Ctrl</kbd> + <kbd>M</kbd> (on Window and Linux) or <kbd>Cmd ⌘</kbd> + <kbd>M</kbd> (on macOS)) to see your changes!
55-
56-
For **iOS**: Hit <kbd>Cmd ⌘</kbd> + <kbd>R</kbd> in your iOS Simulator to reload the app and see your changes!
57-
58-
## Congratulations! :tada:
59-
60-
You've successfully run and modified your React Native App. :partying_face:
61-
62-
### Now what?
63-
64-
- If you want to add this new React Native code to an existing application, check out the [Integration guide](https://reactnative.dev/docs/integration-with-existing-apps).
65-
- If you're curious to learn more about React Native, check out the [Introduction to React Native](https://reactnative.dev/docs/getting-started).
66-
67-
# Troubleshooting
68-
69-
If you can't get this to work, see the [Troubleshooting](https://reactnative.dev/docs/troubleshooting) page.
70-
71-
# Learn More
72-
73-
To learn more about React Native, take a look at the following resources:
74-
75-
- [React Native Website](https://reactnative.dev) - learn more about React Native.
76-
- [Getting Started](https://reactnative.dev/docs/environment-setup) - an **overview** of React Native and how setup your environment.
77-
- [Learn the Basics](https://reactnative.dev/docs/getting-started) - a **guided tour** of the React Native **basics**.
78-
- [Blog](https://reactnative.dev/blog) - read the latest official React Native **Blog** posts.
79-
- [`@facebook/react-native`](https://github.com/facebook/react-native) - the Open Source; GitHub **repository** for React Native.
20+
Then in `FabricExample` run `yarn ios` or run application from Xcode.

0 commit comments

Comments
 (0)