update readme

warp-drive-engineering · Jul 30, 2023 · 74bf983 · 74bf983
1 parent a8b62aa
commit 74bf983
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,19 @@
 # cleanheap
 
+To use:
+
+```bash
+npx cleanheap <input-file-path>
+```
+
+Optionally:
+
+```bash
+npx cleanheap <input-file-path> <output-file-path>
+```
+
+## Contributing
+
 To install dependencies:
 
 ```bash
@@ -12,4 +26,12 @@ To run:
 bun run src/index.ts
 ```
 
+To compile:
+
+```bash
+bun build src/index.ts --outfile bin/cleanheap
+```
+
+## Credits
+
 This project was created using `bun init` in bun v0.7.1. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.