update README for 2.0.0

Author: jsierles

README.md

@@ -1,48 +1,37 @@
-## react-native-audio for iOS and android
-
-An audio recording and playback library for React Native iOS apps.
-
-On iOS, it supports most iOS AVAudioRecorder class configuration options.
+Record and play back audio in your iOS or Android React Native apps.
 
 ### Installation
 
-Install the package via npm, and link the binary to your iOS and Android projects:
+Install the npm package and link it to your project:
 
 ```
 npm install react-native-audio
 react-native link react-native-audio
 ```
 
-#### Extra Android installation step
+On *Android* you need to add a permission to `AndroidManifest.xml`:
 
-Update AndroidManifest.xml by adding the `RECORD_AUDIO` permission:
 ```
 <uses-permission android:name="android.permission.RECORD_AUDIO" />
 ```
 
-### Running the Sample App On iOS
+### Running the Sample App
 
 In the `AudioExample` directory:
 
 ```
 npm install
 react-native run-ios
-```
-
-### Running the Sample App On Android
-
-In the `AudioExample` directory:
-
-```
-npm install
 react-native run-android
 ```
 
 ### Usage
 
-This library supports recording, basic playback and progress reporting. Progress reporting is iOS only for now.
+This library supports recording, basic playback and progress reporting.
 
-To record in AAC format, at 22050 KHz in low quality mono with metering enabled:
+NOTE: Progress reporting is *iOS only* for now.
+
+To record in AAC format, at 22050 KHz in low quality mono:
 
 ```
 import {AudioRecorder, AudioUtils} from 'react-native-audio';
@@ -52,21 +41,33 @@ AudioRecorder.prepareRecordingAtPath(audioPath, {
   SampleRate: 22050,
   Channels: 1,
   AudioQuality: "Low",
-  AudioEncoding: "aac",
-  MeteringEnabled: true
+  AudioEncoding: "aac"
 });
 ```
 
-See [the example](https://github.com/jsierles/react-native-audio/blob/master/AudioExample/index.ios.js) for more options, including playback and callbacks. For more audio play options, check out [React Native Sound](https://github.com/zmxv/react-native-sound)
+#### Cross-platform options
+
+SampleRate: int
+Channels: int
+AudioQuality: string
+AudioEncoding: string
+
+Encodings supported on iOS: lpcm, ima4, aac, MAC3, MAC6, ulaw, alaw, mp1, mp2, alac
+Encodings supported on Android: aac, aac_eld, amr_nb, amr_wb, he_aac, vorbis
+
+#### iOS-only fields
+
+The `MeteringEnabled` boolean to enable audio metering.
 
-### Supported audio formats
+#### Android-only fields
 
-A subset of formats listed here are supported: https://developer.apple.com/reference/coreaudio/1572096-audio_data_format_identifiers
+AudioEncodingBitRate: int
+OutputFormat: string, (mpeg_4, aac_adts, amr_nb, amr_wb, three_gpp, webm)
 
-Currently supported format arguments: lpcm, ima4, aac, MAC3, MAC6, ulaw, alaw, mp1, mp2, alac.
+See [the example](https://github.com/jsierles/react-native-audio/blob/master/AudioExample/index.ios.js) for more options, including playback and callbacks. For more audio play features, check out [React Native Sound](https://github.com/zmxv/react-native-sound)
 
-MP3 recording is not supported on iOS.
+MP3 recording is *not supported* since the underlying platforms do not support it.
 
-Thanks to Brent Vatne, Johannes Lumpe, Kureev Alexey and Matthew Hartman for their assistance.
+Thanks to Brent Vatne, Johannes Lumpe, Kureev Alexey, Matthew Hartman and Rakan Nimer for their assistance.
 
 Progress tracking code borrowed from https://github.com/brentvatne/react-native-video.