]> git.ardis.lu - transcriber/commitdiff
Add additional guidance
authorArdis Lu <ardisglu@gmail.com>
Mon, 23 Dec 2024 04:25:15 +0000 (20:25 -0800)
committerArdis Lu <ardisglu@gmail.com>
Mon, 23 Dec 2024 04:25:15 +0000 (20:25 -0800)
README.md

index abf72571b696bbfcd9be5b93ac0100bebba6ac46..a44a306c6c758badb5a104def4248cc9d8c95efc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -68,3 +68,25 @@ value1 value3 value6
 ```
 
 More examples can be found within the [**`/examples`**](./examples) folder.
+
+## CLI
+
+Use [`bun build`](https://bun.sh/docs/bundler/executables) to generate a portable executable:
+
+```plaintext
+bun build ./index.ts --compile --outfile transcriber
+```
+
+Usage:
+
+```plaintext
+./transcriber --input ./examples/echo.json
+```
+
+## Logging
+
+Pipe `stdout` to a text file to record outputs:
+
+```plaintext
+./transcriber --input ./examples/echo.json > ./output.txt
+```
This page took 0.036568 seconds and 4 git commands to generate.