فهرست منبع

Create README.md

Owen Diffey 8 سال پیش
والد
کامیت
dab55a0092
1فایلهای تغییر یافته به همراه14 افزوده شده و 0 حذف شده
  1. 14 0
      README.md

+ 14 - 0
README.md

@@ -0,0 +1,14 @@
+# UptimeBot
+Uptime Robot Discord bot
+
+## Installation
+1. Clone this repository - `git clone https://github.com/odiffey/UptimeBot.git`
+2. Enter repository directory - `cd UptimeBot`
+3. Install nodemon - `npm install nodemon -g`
+4. Copy the config template - `cp config/template.json config/default.json`
+5. Edit the `config/default.json` file
+  * You can get the token for Discord [here](https://discordapp.com/developers/applications/me)
+  * You can get the loggingChannel and loggingServer ids by enabling developer mode on Discord and click CopyID on the server and channel you want to use.
+  
+## Starting the bot
+1. Run `nodemon` in the repository root