summaryrefslogtreecommitdiff
path: root/rust/wasm/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'rust/wasm/README.md')
-rw-r--r--rust/wasm/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/rust/wasm/README.md b/rust/wasm/README.md
new file mode 100644
index 00000000..bb6f62e7
--- /dev/null
+++ b/rust/wasm/README.md
@@ -0,0 +1,21 @@
+# opencut-wasm
+
+Shared video editor logic compiled to WebAssembly. Used by the [OpenCut](https://github.com/opencut/opencut) web app.
+
+## Install
+
+```bash
+npm install opencut-wasm
+```
+
+## Usage
+
+```ts
+import { formatTimeCode } from "opencut-wasm";
+```
+
+All exports are documented in the [TypeScript definitions](./opencut_wasm.d.ts).
+
+## Source
+
+Functions are implemented in Rust under [`rust/crates/`](../crates/). This package is the compiled WebAssembly output — do not edit it directly.