From de9edaa6d5e7817008f4083ddfd2c8069f0c4ae3 Mon Sep 17 00:00:00 2001
From: "M. Maxwell Watson" <hi@mmwtsn.com>
Date: Sun, 13 Mar 2016 16:08:25 -0400
Subject: [PATCH] Updates documentation
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This library is no longer under construction 🎉
---
 README.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 59 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 97ca617..62b8f37 100644
--- a/README.md
+++ b/README.md
@@ -2,4 +2,62 @@
 
 ## Summary
 
-Manage daily standups from a terminal. Under construction.
\ No newline at end of file
+Manage daily standups from the command line.
+
+## Installation
+
+With [Stack](http://docs.haskellstack.org/en/stable/README/) installed, clone the repository and run:
+
+```
+$ stack setup # Only if you haven't run this before
+$ stack build # Find the path the executable is installed
+$ ln -s /usr/local/sbin CLI_PATH # Use executable path from above
+```
+
+## Quick start
+
+```bash
+$ mkdir ~/.standups
+$ standups --help
+```
+
+## Guide
+
+### Usage
+
+When calling `standups add-done` or `standups add-todo` you will be prompted for a new category and action which will be saved in the appropriate section of the in-progress standup.
+
+### Storage
+
+Standups are saved to your user's `~/.standups` directory in JSON format.
+
+While they are in progress they can be found in the `.in-progress.json` file. Once the standup is complete the in-progress standup is renamed with a time stamp and saved.
+
+### Schema
+
+Standups are made up of `done` and `todo` tasks. Each contains a list of tasks which are made up of a `category` and an `action`.
+
+```json
+{
+  "done": [
+    {
+      "category": "breakfast",
+      "action": "ate a croissant"
+    }
+  ],
+  "todo": [
+    {
+      "category": "life",
+      "action": "write some Haskell"
+    }
+  ]
+}
+```
+
+### Presenting
+
+The easiest way to format this data for a text-based standup is to send it through a templating engine like [Mustache](https://mustache.github.io/mustache.1.html). An example template formatted for Slack is included in the `slack.mustache` file.  Ideally this would happen through the CLI but at the moment that functionality is not supported.
+
+## License
+
+MIT