diff --git a/README.md b/README.md index c0ad06f..42efb44 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ A fork of [irondash_run_loop](https://github.com/irondash/irondash/tree/main/run ## Purpose -Designed for async task management in audio plugin development. +Designed for async task management in audio application/plugin development. Provides access to the host application's main thread run loop without blocking it, enabling plugins to schedule and launch tasks on the main thread. @@ -120,7 +120,17 @@ fn main() { ## Testing -For information on using the test helpers and test harness, see the [Testing Guide](docs/testing.md). +run_loop provides helpers and a test harness for testing code that uses it. +For usage details, see the [Testing Guide](docs/testing.md). + +## Project Status + +The current status is **alpha**. +NovoNotes uses it in production, but the public API is still stabilizing and may include breaking changes. + +## Installation + +- The Rust crate is not published to crates.io. Use it with a pinned `git` + `rev`. ## License diff --git a/README_JA.md b/README_JA.md index 7e4d40d..a0039d9 100644 --- a/README_JA.md +++ b/README_JA.md @@ -5,7 +5,7 @@ ## 目的 -オーディオプラグイン開発における非同期タスク管理での使用を想定。 +オーディオアプリケーション/プラグイン開発における非同期タスク管理での使用を想定。 ホストアプリケーションのメインスレッドをブロックすることなく、そのスレッドのランループへのアクセスを提供する。 これにより、プラグイン起点でメインスレッドのタスクを起動・スケジューリングすることが可能になる。 @@ -118,7 +118,17 @@ fn main() { ## テスト -run_loop のテストヘルパーとテストハーネスの使い方については、[テストガイド](docs/testing.md)を参照してください。 +run_loop を利用したコードをテストする際に便利なヘルパーやテストハーネスを用意しています。 +使い方については、[テストガイド](docs/testing.md)を参照してください。 + +## プロジェクトのステータス + +現時点のステータスは **alpha** です。 +NovoNotes のプロダクションで使用していますが、公開 API はまだ安定化の途上で、破壊的変更があり得ます。 + +## インストール方法 + +- Rust クレートは crate.io 未公開です。`git` + `rev` 固定で利用してください。 ## ライセンス