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. + +- - - + +* Tested Clients +* Downloads +* Supported/Tested Clients +* Installation +* License +* Changelog +* Copyright + +## Features + +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 + +## Supported/Tested Clients + +Full Support + +* Reeder - iPhone + +## Installation + +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. + +## License + +Licensed under GNU GPL version 2 (<- I think this is okay for this plugin…) + +## Changelog + +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