1
0
Fork 0

docs: update README.md

This commit is contained in:
Tanimodori 2022-10-23 04:16:11 +08:00
parent 5a82b39b4e
commit 6ec29dcae2
No known key found for this signature in database
GPG Key ID: 27779538B4410104
1 changed files with 20 additions and 0 deletions

20
README.md Normal file
View File

@ -0,0 +1,20 @@
# Viteburner-template
This is a template for a viteburner project. It is a simple example of how to use Viteburner.
## How to use
Prerequisites: [Node.js](https://nodejs.org/en/download/)
```bash
git clone https://github.com/Tanimodori/viteburner-template.git
cd viteburner-template
npm i
npm run dev
```
In bitburner, select "Options > Remote API", enter the port of viteburner displays (default: `12525`) and click "Connect".
## License
[MIT License](LICENSE) © 2022-present Tanimodori