[draft] chore: cleanup readme file

README.md

@@ -1,133 +1,62 @@
-# React Native Audio Context
+<img src="./internal-docs/assets/react-native-audio-api-gh-cover.png" alt="React Native Audio API" width="100%">
 
-## Internal Documentation
+### React Native Audio API
 
-[Basic interfaces description](./internal-docs/basic-interfaces.md)
+`react-native-audio-api` provides system for controlling audio in React Native environment compatible with Web Audio API specification,
+allowing developers to generate and modify audio in exact same way it is possible in browsers.
 
 ## Installation
 
-```sh
-npm install react-native-audio-context
-```
+1. Install `react-native-audio-api` library
 
-## WebAudio API roadmap and coverage
+   ```bash
+   # using npm
+   npm install react-native-audio-api
 
-<details>
-  <summary><b>AudioContext</b><br/> Android: ✅ <br/>iOS: ✅</summary>
+   # OR using Yarn
+   yarn add react-native-audio-api
+   ```
 
-| Method / Property     | iOS | Android |
-| --------------------- | --- | ------- |
-| 🔹 destination        | ✅  | ✅      |
-| 🔹 sampleRate         | ✅  | ✅      |
-| 🔹 state              | ✅  | ✅      |
-| 🔹 currentTime        | ✅  | ✅      |
-| 🔘 createGain         | ✅  | ✅      |
-| 🔘 createOscillator   | ✅  | ✅      |
-| 🔘 createStereoPanner | ✅  | ✅      |
-| 🔘 createBiquadFilter | ✅  | ✅      |
-| 🔘 close              | ✅  | ✅      |
+## Documentation
 
-</details>
+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/).
+[MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API) is usefull resource to get familiar with audio processing basics.
 
-<details>
-  <summary><b>AudioNode</b><br/> Android: ✅ <br />iOS: ✅</summary>
+For development purposes there is also simplified description of already implemented interfaces as well as overview on Web Audio API coverage.
 
-| Method / Property        | iOS | Android |
-| ------------------------ | --- | ------- |
-| 🔹context                | ✅  | ✅      |
-| 🔹numberOfInputs         | ✅  | ✅      |
-| 🔹numberOfOutputs        | ✅  | ✅      |
-| 🔹channelCount           | ⌛  | ✅      |
-| 🔹channelCountMode       | ⌛  | ⌛      |
-| 🔹channelInterpretation  | ⌛  | ⌛      |
-| 🔘connect                | ✅  | ✅      |
-| 🔘disconnect             | ✅  | ✅      |
+- [Basic interfaces description](./internal-docs/basic-interfaces.md)
+- [Web Audio API coverage](./internal-docs/web-audio-coverage.md)
 
-</details>
+## Examples
 
-<details>
-  <summary><b>AudioScheduledSourceNode</b><br/> Android: ✅ <br />iOS: ✅</summary>
+The source code for the example app is unther the [`/example`](./example/) directory. Check [Example README](./example/README.md) file for installation instruction.
 
-| Method / Property | iOS | Android |
-| ----------------- | --- | ------- |
-| 🔘start           | ✅  | ✅      |
-| 🔘stop            | ✅  | ✅      |
+## Your feedback
 
-</details>
+We are open to new ideas and general feedback. If you want to share your opinion about `react-native-audio-api` or have some thoughts about how it could be further developed, don't hesitate to create an issue or contact the maintainers directly.
 
-<details>
-  <summary><b>AudioDestinationNode</b><br/> Android: ✅ <br />iOS: ✅</summary>
+## Roadmap
 
-| Method / Property | iOS | Android |
-| ----------------- | --- | ------- |
+- [ ] AudioBuffer on iOS
+- [ ] AudioBufferSourceNode on iOS
+- [ ] Split existing examples separate screens using react-navigation
+- [ ] Add simple drum machine implementation
+- [ ] Add example using AudioBufferSourceNode
 
-</details>
-
-<details>
-  <summary><b>AudioParam</b><br/> Android: ✅ <br />iOS: ✅</summary>
-
-| Method / Property              | iOS | Android |
-| ------------------------------ | --- | ------- |
-| 🔹value                        | ✅  | ✅      |
-| 🔹defaultValue                 | ✅  | ✅      |
-| 🔹minValue                     | ✅  | ✅      |
-| 🔹maxValue                     | ✅  | ✅      |
-| 🔘setValueAtTime               | ✅  | ✅      |
-| 🔘linearRampToValueAtTime      | ✅  | ✅      |
-| 🔘exponentialRampToValueAtTime | ✅  | ✅      |
-
-</details>
-
-<details>
-  <summary><b>OscillatorNode</b><br/> Android: ✅ <br />iOS: ✅</summary>
-
-| Method / Property | iOS | Android |
-| ----------------- | --- | ------- |
-| 🔹frequency       | ✅  | ✅      |
-| 🔹detune          | ✅  | ✅      |
-| 🔹type            | ✅  | ✅      |
-
-</details>
-
-<details>
-  <summary><b>GainNode</b><br/> Android: ✅ <br />iOS: ✅</summary>
-
-| Method / Property | iOS | Android |
-| ----------------- | --- | ------- |
-| 🔹gain            | ✅  | ✅      |
-
-</details>
-
-<details>
-  <summary><b>StereoPannerNode</b><br/> Android: ✅ <br />iOS: ✅</summary>
-
-| Method / Property | iOS | Android |
-| ----------------- | --- | ------- |
-| 🔹pan             | ✅  | ✅      |
-
-</details>
-
-<details>
-  <summary><b>BiquadFilterNode</b><br/> Android: ✅ <br />iOS: ✅</summary>
+## License
 
-| Method / Property | iOS | Android |
-| ----------------- | --- | ------- |
-| 🔹frequency       | ✅  | ✅      |
-| 🔹detune          | ✅  | ✅      |
-| 🔹Q               | ✅  | ✅      |
-| 🔹gain            | ✅  | ✅      |
-| 🔹type            | ✅  | ✅      |
+react-native-audio-api library is licensed under [The MIT License](./LICENSE)
 
-</details>
+## Credits
 
-## Contributing
+This project has been bult and is maintained thanks to the support from [Software Mansion](https://swmansion.com)
 
-See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
+[![swm](https://logo.swmansion.com/logo?color=white&variant=desktop&width=150&tag=react-native-reanimated-github 'Software Mansion')](https://swmansion.com)
 
-## License
+## Community Discord
 
-MIT
+[Join the Software Mansion Community Discord](https://discord.swmansion.com) to chat about React Native Audio API or other Software Mansion libraries.
 
----
+## react-native-audio-api is created by Software Mansion
 
-Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)
+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=reanimated&utm_medium=readme).

example/README.md

@@ -1,79 +1,20 @@
-This is a new [**React Native**](https://reactnative.dev) project, bootstrapped using [`@react-native-community/cli`](https://github.com/react-native-community/cli).
+# React Native Audio API example application
 
-# Getting Started
+## Installation & running application
 
->**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.
+Before running application you need to install all dependencies. To do that:
 
-## Step 1: Start the Metro Server
+- In project's root directory run `yarn install`
+- In example directory run `yarn install`
 
-First, you will need to start **Metro**, the JavaScript _bundler_ that ships _with_ React Native.
+### Android
 
-To start Metro, run the following command from the _root_ of your React Native project:
+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.
 
-```bash
-# using npm
-npm start
+Then you can run this application by `yarn android` or from Android Studio.
 
-# OR using Yarn
-yarn start
-```
+### iOS
 
-## Step 2: Start your Application
+To run on iOS first go to `example/ios` and run `pod install`. This will install pods for Fabric architecture.
 
-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:
-
-### For Android
-
-```bash
-# using npm
-npm run android
-
-# OR using Yarn
-yarn android
-```
-
-### For iOS
-
-```bash
-# using npm
-npm run ios
-
-# OR using Yarn
-yarn ios
-```
-
-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.
-
-This is one way to run your app — you can also run it directly from within Android Studio and Xcode respectively.
-
-## Step 3: Modifying your App
-
-Now that you have successfully run the app, let's modify it.
-
-1. Open `App.tsx` in your text editor of choice and edit some lines.
-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!
-
-   For **iOS**: Hit <kbd>Cmd ⌘</kbd> + <kbd>R</kbd> in your iOS Simulator to reload the app and see your changes!
-
-## Congratulations! :tada:
-
-You've successfully run and modified your React Native App. :partying_face:
-
-### Now what?
-
-- 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).
-- If you're curious to learn more about React Native, check out the [Introduction to React Native](https://reactnative.dev/docs/getting-started).
-
-# Troubleshooting
-
-If you can't get this to work, see the [Troubleshooting](https://reactnative.dev/docs/troubleshooting) page.
-
-# Learn More
-
-To learn more about React Native, take a look at the following resources:
-
-- [React Native Website](https://reactnative.dev) - learn more about React Native.
-- [Getting Started](https://reactnative.dev/docs/environment-setup) - an **overview** of React Native and how setup your environment.
-- [Learn the Basics](https://reactnative.dev/docs/getting-started) - a **guided tour** of the React Native **basics**.
-- [Blog](https://reactnative.dev/blog) - read the latest official React Native **Blog** posts.
-- [`@facebook/react-native`](https://github.com/facebook/react-native) - the Open Source; GitHub **repository** for React Native.
+Then in `example` run `yarn ios` or run application from Xcode.