From 3826632288dc105835bd50755b91d5d2e4e41b2a Mon Sep 17 00:00:00 2001
From: Pingex <pingex@pingex.net>
Date: Sat, 14 May 2016 19:53:44 +0200
Subject: [PATCH] Basic ReadMe

---
 readme.md | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/readme.md b/readme.md
index a7f146b..4310ff6 100644
--- a/readme.md
+++ b/readme.md
@@ -1,2 +1,22 @@
 # DiscordBot
-Modular Bot for Discord, coming soon
\ No newline at end of file
+
+## What is this
+DiscordBot is just another bot written in Java. So basically it's a modular bot, which means you can create your own plugins to integrate with it. *coming soon*
+
+## Getting started
+* You need Java 8. Run `java -version` to check.
+* You need to have the latest gradle installed, or dependencies won't resolve.
+* Execute the following:
+```
+git clone https://git.pingex.net/pingex/DiscordBot
+cd DiscordBot
+gradle jar
+```
+
+* You can find the compiled jar in `build/libs/DiscordBot-X.Y.Z.jar`.
+* Copy `config.example.ini` to `config.ini` and place it in the same directory as the jar. Then tweak it following your needs.
+* Then `java -jar DiscordBot-X.Y.Z.jar` to run it.
+
+Notes:
+
+* No plugin will start by default. You need to enable them by specifying their full classname in the config file. (behavior to be changed)
\ No newline at end of file