diff --git a/README.md b/README.md index 9bbf3a6..ef4d25f 100644 --- a/README.md +++ b/README.md @@ -1 +1,16 @@ -# Channel Guardian \ No newline at end of file +[![Build Status](https://travis-ci.org/condolent/channel-guardian.svg?branch=master)](https://travis-ci.org/condolent/channel-guardian) ![GitHub issues](https://img.shields.io/github/issues/condolent/channel-guardian) ![GitHub release (latest by date)](https://img.shields.io/github/v/release/condolent/channel-guardian) +# Channel Guardian +A discord bot that allows server managers to password protect text channels. + +## Setup +1. Download the [latest release](https://github.com/condolent/channel-guardian/releases/latest) +2. Create the file `resources/bot.properties` and paste this into the file: +```properties +token=yourtoken +db.host=hostip +db.name=database +db.user=username +db.pass=password +``` +3. Replace the property values in your file with your settings. +4. Build, done!