From 28ecc6ab700fcabee540057bd5e3fa1e49fde96c Mon Sep 17 00:00:00 2001
From: Torsten Stelling <stelling@neogen.info>
Date: Thu, 27 Jun 2013 22:08:39 +0200
Subject: [PATCH] added first readme file

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0d3d651
--- /dev/null
+++ b/README.md
@@ -0,0 +1,47 @@
+# TinyTinyRSS Fever API plugin
+
+## Description
+
+This plugin is an open source module for TinyTinyRSS which simulates the Fever API for reading the RSS Feeds with your Fever clients.
+
+- - -
+
+* <a href="#features">Tested Clients</a>
+* <a href="#download">Downloads</a>
+* <a href="#supported">Supported/Tested Clients</a>
+* <a href="#installation">Installation</a>
+* <a href="#license">License</a>
+* <a href="#changelog">Changelog</a>
+* <a href="#copyright">Copyright</a>
+
+## <a name="features">Features</a>
+
+Following Features are implemented:
+
+* getting new RSS items
+* getting starred RSS items
+* setting read marker for item(s)
+* setting starred marker for item(s)
+* hot is **not** supported
+
+## <a name="supported">Supported/Tested Clients</a>
+
+Full Support
+
+* Reeder - iPhone
+
+## <a name="installation">Installation</a>
+
+Upload the ```fever``` folder in the ```plugins``` folder of your TinyTinyRSS installation. Enable the plugin in the preferences and set your password for the Fever API.
+
+See [here](http://tt-rss.org/forum/viewtopic.php?f=22&t=1981) for more detailed informations.
+
+## <a name="license">License</a>
+
+Licensed under GNU GPL version 2 (<- I think this is okay for this plugin…)
+
+## <a name="changelog">Changelog</a>
+
+v1.0-v1.2 - 2013/5/27 - DigitalDJ version
+
+* see this [thread](http://tt-rss.org/forum/viewtopic.php?f=22&t=1981) in the TinyTinyRSS Forum