Adding documentation

Change-Id: I7bfcbc4e981658fce4deaf9900d23b9ec8600fa4

1 files changed, 19 insertions, 22 deletions

diff --git a/README.md b/README.md
index 13bb487e..736bc7c1 100755
--- a/README.md
+++ b/README.md
@@ -1,32 +1,29 @@
 # Oboe
-Oboe is a C++ library which makes it easy to build high-performance audio apps
-on Android. It's a C++ wrapper for the AAudio and OpenSL ES audio APIs. It runs
-on Android versions from Jelly Bean 4.1 (API 16) upwards.
+**Oboe is not yet ready for use. This repo is intended for Oboe developers only.**
 
-On Oreo (API 26) or later versions, Oboe can use AAudio or OpenSL ES.
-On Nougat (API 25) or earlier versions, Oboe will only use OpenSL ES.
+Oboe is a C++ library which makes it easy to build high-performance audio apps on Android. It was created primarily to allow developers to target a single audio API, instead of both OpenSL ES (API 9+) and AAudio (API 26+).
 
-This is not an official Google product.
+To get started please read the [getting started guide](GettingStarted.md).
 
-## Prerequisites
-- Android Studio 2.3.3 or above
+Oboe is not an official Google product.
 
-## Adding Oboe to your Android Studio project
-1. Add the Oboe source code into `$PROJECT_DIR/app/src/main/cpp/oboe`. You can
-either use `git clone` or if your project is already a git repository you can
-add Oboe as a submodule: `git submodule add github.com/google/oboe`.
+**Note:** This version of Oboe only supports playback (output) streams. Support for recording (input) streams is in active development.
 
-2. Update your project's `app/CMakeLists.txt` file to include the Oboe source
-and header files, as well as the OpenSLES library by adding the following lines:
+## Features
+- Compatible with API 16 onwards - runs on 99% of Android devices
+- Chooses the audio API (OpenSL ES on API 16+ or AAudio on API 26+) which will give the best audio performance on the target Android device
+- Automatic latency tuning
+- Modern C++ allowing you to write clean, elegant code
 
-    `include_directories(src/main/cpp/oboe/include src/main/cpp/oboe/src)
-    file(GLOB_RECURSE app_native_sources src/main/cpp/* src/main/cpp/oboe/src/*)
-    add_library(native-lib SHARED ${app_native_sources})
-    target_link_libraries(native-lib log OpenSLES)`
+## Requirements
+To build Oboe you will need the [Android NDK](https://developer.android.com/ndk/index.html) r16 or above
 
-3. Check that your project builds.
+## Documentation
+- [Getting Started Guide](GettingStarted.md)
+- [Full Guide to Oboe](FullGuide.md)
 
-Now the Oboe source is in your project it's really easy to
-[contribute](CONTRIBUTING) modifications back to Oboe.
+## Sample code
+Example apps can be found in the [Android high-performance audio repository](https://github.com/googlesamples/android-audio-high-performance/tree/master/oboe)
 
-TODO: Add getting started guide, sample code and links to sample apps
+## Contributing
+We would love to receive your pull requests. Before we can though we need you to read the [contributing](CONTRIBUTING.md) guidelines.