Add Documentation

README.md

@@ -0,0 +1,71 @@
+# DayZ R. Bot [![Node.js](https://nodejs.org/static/images/logo.svg)](https://nodejs.org/en)
+
+A general purpose Discord Bot to handle DayZ Killfeed, stats, alarms and factions' armbands and more using Nitrado Log files. 
+
+***Explore the docs »***
+* [Getting Started](#getting-started)
+* [Contact](#contact)
+
+### Built With
+
+* [Node.js](https://nodejs.org/en)
+* [Discord.js](https://discord.js.org/#/)
+* [MongoDB](https://www.mongodb.com/)
+
+## About The Project
+
+Originally just a simple project to have factions select their armbands, and track that in the Discord. With the increasing difficulty of other DayZ killfeed bots, I  
+expanded this project to include the killfeed, alarms, banking, and much much more.
+
+## Getting Started
+
+The bot requires minimal setup to get started.
+
+### Prerequisites
+
+1. [Create your Discord Bot and get the private token](https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token) for later configuration. Invite this bot to your desired discord server.
+
+2. You'll need some important private information from your Nitrado account for later configuration.  
+  i.   Your Nitrado user ID  
+  ii.  Your DayZ Nitrado server ID  
+  iii. Create and Copy your Nitrado authentication token.  
+
+3. You'll need to setup an instance of MongoDB. You can use the cloud platform, MongoDB Atlas, or create your own instance locally.  
+  i.  [Create your MongoDB Altas instance.](https://www.mongodb.com/docs/manual/tutorial/getting-started/)  
+  ii. [Create your local MongoDB server instance.](https://www.mongodb.com/docs/manual/administration/install-community/)  
+
+  After this, you'll need to get your MongoURI from your database instance, as well as your database name for later configuration.
+
+### Installation
+
+1. Clone the repo
+```
+    $ git clone https://github.com/SowinskiBraeden/dayz-reforger.git
+    $ cd dayz-reforger
+```
+
+<br>
+
+2. Rename `.env.example` to `.env`
+
+<br>
+
+3. Enter desired values into `.env`
+```
+    token='Your Discord Bot token'
+    mongoURI='Your mongodb URI'
+    dbo='Your mongodb database'
+    SERVER_ID='Your Nitrado server ID'
+    USER_ID='Your Nitrado user ID'
+    AUTH_KEY='Your Nitrado Auth Token'
+    GuildID='Your Discord Guild ID'
+```
+
+<br>
+
+<!-- CONTACT -->
+## Contact
+
+Braeden Sowinski - [@BraedenSowinski](https://twitter.com/BraedenSowinski) - sowinskibraeden@gmail.com - @mcdazzzled on Discord
+
+Project Link: [https://github.com/SowinskiBraeden/dayz-reforger](https://github.com/SowinskiBraeden/dayz-reforger)