osu/tweaks
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
Michael Zhang 2024-07-27 16:29:54 -05:00
parent cf9cf06d2b
commit 184a6b6502
1 changed files with 14 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -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