Added README.

README.md

@@ -0,0 +1,84 @@
+# WanikaniBurned [![Build Status](https://jenkins.neviyn.co.uk/buildStatus/icon?job=wanikaniburned/TOXENV=py34)](https://jenkins.neviyn.co.uk/job/wanikaniburned/TOXENV=py34)
+## Synopsis
+
+WanikaniBurned is a standalone web application designed to deliver a similar experience to reviews on WaniKani.
+
+The intent is to use data pulled from the WaniKani API to facilitate the review of items with the *burned* SRS state but
+filter options are provided to allow review of user items with any state.
+
+## Demo
+
+http://fireturtle.neviyn.co.uk
+
+Demo API key: **demo**
+
+## Deployment
+
+[Download the latest build.](https://jenkins.neviyn.co.uk/job/wanikaniburned/TOXENV=py34/lastStableBuild/artifact/*zip*/archive.zip)
+
+Unzip build archive.
+
+    unzip build.zip
+
+Create a file config.py in the base directory and added configuration options (see example-config.py).
+
+    # config.py
+    SQLALCHEMY_DATABASE_URI = 'sqlite:///wanikani.db'
+    SECRET_KEY = "putabettersecretkeyhere"
+    DEBUG = False
+    PORT = 5000
+    SQLALCHEMY_TRACK_MODIFICATIONS = False
+
+Install dependencies.
+
+    pip install -r requirements.txt
+
+Start application.
+
+    python wanikaniburned.py
+
+## Installation
+
+Clone repository.
+
+    https://git.neviyn.co.uk/git/neviyn/wanikaniburned.git
+
+Install dependencies.
+
+    pip install -r requirements.txt
+
+Install CoffeeScript (requires npm)
+
+    npm install -g coffee-script
+
+Compile CoffeeScript.
+
+    coffee --map --compile ./static
+
+### Optional
+
+Auto watch and recompile CoffeeScript file(s) on changes.
+
+    coffee --map --watch --compile ./static
+
+## Testing
+
+Run the tox command.
+
+    tox
+
+If you do not have tox installed, it can be installed using the following.
+
+    pip install tox
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2016 Nathan Cannon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.