-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from devcodeabode/readme-placeholder
Update README.md
- Loading branch information
Showing
1 changed file
with
23 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,23 @@ | ||
# discordjs-bot-bootstrap | ||
A bootstrap for DiscordJS bots | ||
# MoDiBo | ||
A Discord bot built prodominatly by students, former students, and alumni of Truman State University | ||
|
||
## What is MoDiBo? | ||
MoDiBo is a Discord bot used to automate server management, boost member activity, and increase member retention. | ||
|
||
## Installation | ||
First install [NodeJs](https://www.npmjs.com/) | ||
|
||
Then run the following commands in your terminal | ||
```sh | ||
git clone https://github.com/devcodeabode/MoDiBo.git | ||
cd MoDiBo | ||
npm install | ||
``` | ||
|
||
## NPM Commands | ||
Command | Description | ||
--- | --- | ||
npm run start | Starts MoDiBo | ||
npm run update | Pulls the latest version of the master branch and installs packages | ||
npm run clean | Deletes any local changes to the code and updates the project | ||
npm run cleanLogs | Deletes all information in local logs |