aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDon Turner <donturner@google.com>2017-10-18 18:50:03 +0100
committerDon Turner <donturner@google.com>2017-10-19 17:24:28 +0100
commit1b3c4735541b31d84af81afdfc3b7dbc7d83d554 (patch)
tree2ad5d9f3370184771e46437025054f8f8832147e /README.md
parent695114c80cbe6f9feaa542f34ad9326c27871b13 (diff)
downloadoboe-1b3c4735541b31d84af81afdfc3b7dbc7d83d554.tar.gz
Adding developer preview text
Change-Id: I3ed6d18c96fa851e14f1da4c02218298e5e64f23
Diffstat (limited to 'README.md')
-rwxr-xr-xREADME.md14
1 files changed, 8 insertions, 6 deletions
diff --git a/README.md b/README.md
index 736bc7c1..7c950596 100755
--- a/README.md
+++ b/README.md
@@ -1,13 +1,11 @@
# Oboe
-**Oboe is not yet ready for use. This repo is intended for Oboe developers only.**
+**Oboe is currently in developer preview.**
-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+).
+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 simplified API that works across multiple API levels back to API level 16 (Jelly Bean).
To get started please read the [getting started guide](GettingStarted.md).
-Oboe is not an official Google product.
-
-**Note:** This version of Oboe only supports playback (output) streams. Support for recording (input) streams is in active development.
+**Note:** This version (0.9) of Oboe only supports playback (output) streams. Support for recording (input) streams is in active development.
## Features
- Compatible with API 16 onwards - runs on 99% of Android devices
@@ -26,4 +24,8 @@ To build Oboe you will need the [Android NDK](https://developer.android.com/ndk/
Example apps can be found in the [Android high-performance audio repository](https://github.com/googlesamples/android-audio-high-performance/tree/master/oboe)
## Contributing
-We would love to receive your pull requests. Before we can though we need you to read the [contributing](CONTRIBUTING.md) guidelines.
+We would love to receive your pull requests. Before we can though, please read the [contributing](CONTRIBUTING.md) guidelines.
+
+## Version history
+
+- 18th October 2017 - v0.9 Initial developer preview \ No newline at end of file