From 43340749c5f53b9c305613a30e59c3a261ba868b Mon Sep 17 00:00:00 2001 From: Ardis Lu Date: Sun, 22 Dec 2024 20:25:15 -0800 Subject: [PATCH] Add additional guidance --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index abf7257..a44a306 100644 --- 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 +``` -- 2.47.3