From d9e0d5fca68382764e142976c09826db652cf59e Mon Sep 17 00:00:00 2001
From: "Timothy J. Warren" <tim@timshomepage.net>
Date: Tue, 16 Jun 2015 11:33:06 -0400
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..b4a9004a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# Hummingbird Anime Client
+
+A self-hosted client that allows custom formatting of data from the hummingbird api
+
+[[Hosted Example](https://anime.timshomepage.net)]
+
+## Features
+
+* Anime List views:
+	* Watching
+	* Plan to Watch
+	* On Hold
+	* Dropped
+	* Completed 
+	* All of the above
+	
+* Manga List views:
+	* Reading
+	* Plan to Read
+	* On Hold
+	* Dropped
+	* Completed
+	* All of the above
+	
+* Anime collection view (segmented by media type):
+	* Cover Images
+	* Table List
+	
+### Requirements
+
+* PHP 5.4+
+* PDO SQLite (For collection tab)
+
+### Installation
+
+1. Install dependencies via composer: `composer install`
+2. Change the `WHOSE` constant declaration in `index.php` to your name
+3. Configure settings in `app/config/config.php` to your liking
+ 
\ No newline at end of file