From 57246a423504c292fe94e07533a06f70e27f3186 Mon Sep 17 00:00:00 2001 From: Ricardo Date: Fri, 5 Jun 2026 19:02:58 +0900 Subject: [PATCH 1/2] docs: add project status section to README - Add alpha status badge - Document supported platforms and features - List known issues with links to tracker Closes #21 --- README.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c1b2b2c..92a06f6 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,37 @@ > Use [Elementary Audio][elem] in your React Native app -This is alpha quality software. +[![Alpha](https://img.shields.io/badge/status-alpha-orange)](https://github.com/tamlyn/react-native-elementary/releases) [elem]: https://elementary.audio +## Project status + +Alpha. The API is subject to change. + +### Supported platforms + +- iOS +- Android + +### Supported features + +- Native Elementary Audio renderer via `useRenderer` hook +- Real-time `setProperty` for graph parameter updates +- iOS audio session configuration and management +- Configurable event polling (`el.snapshot`, `el.meter`, `el.scope`, `el.fft`) +- Audio resource loading via VFS + +### Known issues + +- Native node types (`el.metro`, `el.time`, `el.fft`, `el.convolve`) are not yet + supported (see [#4][i4]) +- Audio I/O may not update automatically when device connection changes + (see [#15][i15]) + +[i4]: https://github.com/tamlyn/react-native-elementary/issues/4 +[i15]: https://github.com/tamlyn/react-native-elementary/issues/15 + ## Installation ```sh From 9ec60713a4d7db2de0c27bc8d4f233cf09dc7f05 Mon Sep 17 00:00:00 2001 From: Ricardo Date: Fri, 5 Jun 2026 19:37:38 +0900 Subject: [PATCH 2/2] docs: update known issues to reflect partial #15 progress --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 92a06f6..5bf9c17 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,8 @@ Alpha. The API is subject to change. - Native node types (`el.metro`, `el.time`, `el.fft`, `el.convolve`) are not yet supported (see [#4][i4]) -- Audio I/O may not update automatically when device connection changes +- Audio I/O may not update automatically when device connection changes; + engine restart on route change is handled, re-graph against new route is pending (see [#15][i15]) [i4]: https://github.com/tamlyn/react-native-elementary/issues/4