Initial Commit
This commit is contained in:
22
scripts/split-audio-fx-plugin/template/README.md.template
Normal file
22
scripts/split-audio-fx-plugin/template/README.md.template
Normal file
@@ -0,0 +1,22 @@
|
||||
# @suaveplan/audio-fx-plugin-{PLUGIN_NAME}
|
||||
|
||||
{PLUGIN_DESCRIPTION}
|
||||
|
||||
Member of the `@suaveplan/audio-fx-plugin-*` family. Universal-tier (browser / server / offline / worklet identical). Depends on `@suaveplan/audio-fx-plugin-base` for the `AudioFxPlugin` contract; declares no other `@suaveplan/audio-fx-plugin-*` deps.
|
||||
|
||||
## Composition
|
||||
|
||||
```ts
|
||||
import { PluginChain, DefaultBusRegistry } from "@suaveplan/audio-fx-plugin-base/chain";
|
||||
import { /* Plugin */ } from "@suaveplan/audio-fx-plugin-{PLUGIN_NAME}";
|
||||
|
||||
const plugin = new /* Plugin */();
|
||||
const chain = new PluginChain({
|
||||
buses: new DefaultBusRegistry(),
|
||||
plugins: [plugin],
|
||||
});
|
||||
```
|
||||
|
||||
## Status
|
||||
|
||||
Replaces the `./{PLUGIN_NAME}` subpath of the bundled `@suaveplan/audio-plugins-fx`. See `openspec/archive/2026-05-19-split-audio-plugins-fx/` for migration history.
|
||||
Reference in New Issue
Block a user