diff --git a/README.md b/README.md index 1cc81ac..e050fc3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # tweaks +## Install + +No distribution packages yet, please follow the development guide to use for now! + +## Development guide + To install dependencies: ```bash @@ -9,7 +15,13 @@ bun install To run: ```bash -bun run index.ts +bun run dev ``` -This project was created using `bun init` in bun v1.1.20. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime. +Add `dist/manifest.json` as a debug extension. + +## Contact + +Author: Michael Zhang + +License: GPL-3.0 \ No newline at end of file