add readme

This commit is contained in:
ShuriZma 2024-03-30 15:33:19 +01:00
parent e4e20af282
commit 276a5ce63d
Signed by: ShuriZma
GPG Key ID: 8D289758EE9B8074
1 changed files with 11 additions and 0 deletions

11
README.md Normal file
View File

@ -0,0 +1,11 @@
## How to install & run this bot.
Prerequisites:
* [NodeJS/NPM](https://nodejs.org/en/download)
* Potentially [Git](https://git-scm.com/downloads)
1. Download the repo files.
1. `git clone https://git.shuri.gg/ShuriZma/WordCounterBot.git`
2. or just click the 3 dots at the top right and download the ZIP
2. Open a console inside the downloaded repo folder.
3. Run `npm i`
4. Run `npm run bot`