Skip to content

Commit

Permalink
Merge pull request #13 from devcodeabode/update-readme
Browse files Browse the repository at this point in the history
Updated README
  • Loading branch information
jwMaxwell authored Apr 23, 2022
2 parents d24a091 + 3a419d8 commit 3df5fa0
Showing 1 changed file with 20 additions and 7 deletions.
27 changes: 20 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,36 @@
# MoDiBo
A Discord bot built prodominatly by students, former students, and alumni of Truman State University

A Discord bot built prodominatly by students, former students, and alumni of Truman State University. This project is brand new and very much a work in progress.

## 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
```

Next, you will need to copy `./src/.env.template` to `./src/.env`. Once you have done this, add your bot token to `DISJS_BOT_TOKEN` and add a Discord webhook to `WINSTON_DISCORD_WEBHOOK`.

Now you can run the bot using `npm run start`.

## 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

| 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 |

## Contribution

If you would like to contribute to MoDiBo, you can join our [development Discord](https://discord.gg/QqP6djXEyk). Once you have joined, an administrator will reach out and grant required accesses. All information regarding standards and expectations can be found in the Discord as well.

0 comments on commit 3df5fa0

Please sign in to comment.