From cda772f4fa8569d9016672d97f03d3e1f60f99f7 Mon Sep 17 00:00:00 2001
From: SeanOMik <seanomik@gmail.com>
Date: Mon, 22 Jun 2020 17:30:56 -0500
Subject: [PATCH] Do the readme.

---
 README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 50 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index b2d9881..d08e88b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,50 @@
-# nimcord
-A Discord API wrapper written in Nim!
+<h1 align="center">NimCord</h1>
+
+<p align="center">
+<a href="https://discord.gg/9U4EpP9"><img src="https://discordapp.com/api/guilds/716387781055873134/widget.png?style=shield"></a>
+<br>
+Memory optimized, simple, and feature rich Discord API wrapper written in Nim.
+</p>
+
+# NimCord
+A Discord API wrapper written in Nim. Inspired, and created by the author of a memory optimized Discord Library named DisC++.
+
+## State
+NimCord is currently in a testing state. If you want to use it, you can but you may encounter errors. If you do encounter errors, create a GitHub issue or join the Discord server.
+
+## Dependencies
+* [Websocket.nim](https://github.com/niv/websocket.nim)
+
+## Documenation
+You can generate documenation by running `generate_docs.bat/sh` (depending on your system). Documentation is outputted to the `docs` directory.
+
+## What makes NimCord different?
+* Low memory usage.
+* Even though its memory optimized, it's still easy to use without loosing any features.
+* If an member, or channel, is somehow not in cache, it will request the object from the REST api and update the cache to ensure that your bot doesn't crash.
+* Other libraries don't have a command handler built in and also doesn't have a event handler that supports multiple listeners.
+
+## How to install:
+1. Install [Nim](https://nim-lang.org/)
+2. Install NimCord.
+   * NimCord is not yet available on the official Nimble package repository. To install it, you need to clone this repo and in the project root, run: `nimble install`
+
+### Note: 
+* If you already have Websocket.nim installed, you need to make sure you have version 0.4.1 installed.
+* To compile you must define `ssl` example: `nim compile -d:ssl --run .\examples\basic.nim`
+
+You can view examples in the [examples](examples) directory.
+
+
+# Todo:
+- [x] Finish all REST API calls.
+- [x] Handle all gateway events.
+- [x] Reconnecting
+- [ ] Memory optimizations.
+  - [ ] Member
+  - [ ] Channel
+  - [ ] Guild
+  - [ ] Misc.
+- [ ] Sharding.
+- [ ] Audit log.
+- [ ] Voice.
\ No newline at end of file