diff --git a/README.md b/README.md index 15f53d5..0cdfe7c 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,18 @@ Applications choose and provision the SDK models themselves. This keeps model se and deployment under application control while the plugins handle LiveKit audio formats, stream lifecycle, observability, and error recovery. +> [!IMPORTANT] +> The official LiveKit plugins are the recommended integration path for most applications. They +> support LiveKit Cloud, integrate more deeply with the LiveKit ecosystem and tooling, and offer +> stronger stability guarantees. Avoiding breaking changes is an explicit goal of the official +> plugins. +> +> The ai-coustics-maintained plugins in this repository follow a faster release cadence and are +> designed for teams that want early access to the latest ai-coustics models and product features. +> Some of those capabilities may be experimental and subject to change, and use of these plugins is +> billed separately through ai-coustics. Choose them when early adoption of new ai-coustics +> capabilities is important for your application. + ## Packages | Runtime | Package | Documentation | @@ -25,9 +37,11 @@ The runtime guides cover migration from the official plugins, model provisioning integration, Processor enhancement settings, VAD parameters, authentication, and operational constraints. -> These packages replace LiveKit's official `livekit-plugins-ai-coustics` and -> `@livekit/plugins-ai-coustics` packages; they are not extensions of them. Uninstall the official -> package for your runtime before migrating, and do not mix objects from the two implementations. +> These packages are alternatives to LiveKit's official +> [`livekit-plugins-ai-coustics`](https://pypi.org/project/livekit-plugins-ai-coustics/) and +> [`@livekit/plugins-ai-coustics`](https://www.npmjs.com/package/@livekit/plugins-ai-coustics) +> packages, not extensions of them. If you choose to migrate, uninstall the official packages for +> your runtime and do not mix objects from the two implementations. ## Repository contents diff --git a/node/README.md b/node/README.md index 0b20e22..ef1dd89 100644 --- a/node/README.md +++ b/node/README.md @@ -3,11 +3,25 @@ Audio enhancement, voice activity detection, and audio-quality analysis for LiveKit Agents, backed by the public `@ai-coustics/aic-sdk` package. -> This package replaces `@livekit/plugins-ai-coustics`. Uninstall the official package before -> migrating, and do not mix objects from the two implementations. +> [!IMPORTANT] +> The official +> [`@livekit/plugins-ai-coustics`](https://www.npmjs.com/package/@livekit/plugins-ai-coustics) +> package is the recommended integration path for most applications. It supports LiveKit Cloud, +> integrates more deeply with the LiveKit ecosystem and tooling, and offers stronger stability +> guarantees. Avoiding breaking changes is an explicit goal of the official plugin. +> +> This ai-coustics-maintained package follows a faster release cadence and is designed for teams +> that want early access to the latest ai-coustics models and product features. Some of those +> capabilities may be experimental and subject to change, and use of this package is billed +> separately through ai-coustics. Choose it when early adoption of new ai-coustics capabilities is +> important for your application. ## Installation +> This package is an alternative to `@livekit/plugins-ai-coustics`, not an extension of it. If you +> choose to migrate, uninstall the official package and do not mix objects from the two +> implementations. + ```bash npm uninstall @livekit/plugins-ai-coustics npm install @ai-coustics/livekit-plugin diff --git a/python/README.md b/python/README.md index 897a830..9acb102 100644 --- a/python/README.md +++ b/python/README.md @@ -3,11 +3,24 @@ Audio enhancement, voice activity detection, and audio-quality analysis for LiveKit Agents, backed by the public `aic-sdk` package. -> This package replaces `livekit-plugins-ai-coustics`. Do not install both packages because they -> provide the same `livekit.plugins.ai_coustics` import path. +> [!IMPORTANT] +> The official +> [`livekit-plugins-ai-coustics`](https://pypi.org/project/livekit-plugins-ai-coustics/) package is +> the recommended integration path for most applications. It supports LiveKit Cloud, integrates +> more deeply with the LiveKit ecosystem and tooling, and offers stronger stability guarantees. +> Avoiding breaking changes is an explicit goal of the official plugin. +> +> This ai-coustics-maintained package follows a faster release cadence and is designed for teams +> that want early access to the latest ai-coustics models and product features. Some of those +> capabilities may be experimental and subject to change, and use of this package is billed +> separately through ai-coustics. Choose it when early adoption of new ai-coustics capabilities is +> important for your application. ## Installation +> This package is an alternative to `livekit-plugins-ai-coustics`, not an extension of it. Do not +> install both packages because they provide the same `livekit.plugins.ai_coustics` import path. + ```bash pip uninstall livekit-plugins-ai-coustics pip install ai-coustics-livekit-plugin