Added instructions to README
This commit is contained in:
parent
2b41925813
commit
4e326080e6
13
README.md
13
README.md
|
@ -1,3 +1,14 @@
|
|||
# irc-bot
|
||||
|
||||
aewens's IRC bot for irc.tilde.team
|
||||
aewens's IRC bot for irc.tilde.team
|
||||
|
||||
## Setting up
|
||||
|
||||
1. Install the dependencies using `$ npm install`
|
||||
2. Create the needed JSON files using:
|
||||
```bash
|
||||
$ cp config.example.json config.json
|
||||
$ cp blacklist.example.json blacklist.json
|
||||
```
|
||||
3. Fill out the entries in `config.json`
|
||||
4. Run the bot using `node bot.js` or `npm start`
|
Loading…
Reference in New Issue