From e653f48ad8bc02384200a491078a087c5f2b025a Mon Sep 17 00:00:00 2001
From: Raven Scott <raven@chksrv.pro>
Date: Tue, 25 Jan 2022 00:03:09 +0000
Subject: [PATCH] add readme

---
 README.md | 40 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5ed1e55
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+
+# DisKan - A discord bot for KanBoard via its API
+
+This bot is a work in progress, its goal is to allow you to manage and view the information about your kanboard projects easily and efficently.
+
+Currently, you can view a summary of your currently opened tasks and information about your projects, the bot will auto populate its information from the API at your kanboard installation.
+
+# Installation Steps:
+
+Clone the Repo:
+```
+git clone https://git.codingvm.codes/snxraven/DisKan.git
+```
+
+Change to the DisKan dir:
+```
+cd DisKan
+```
+
+NPM Install:
+```
+npm install
+```
+
+Edit the .env.default config to your needs:
+```
+DISCORD_TOKEN=
+OWNER=
+ROOT_DOMAIN=board.yourdomain.com
+KANBOARD_API_KEY=
+PER_PAGE=2
+```
+
+Start the bot:
+```
+node index.js
+```
+
+Pull requests are welcome :) 
+