docs: update README.md
This commit is contained in:
parent
5a82b39b4e
commit
6ec29dcae2
|
@ -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
|
Loading…
Reference in New Issue