Skip to content

Commit

Permalink
Updated README file.
Browse files Browse the repository at this point in the history
  • Loading branch information
DontNeedGithubAccount committed Sep 28, 2013
1 parent 3e76ea1 commit b412a77
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Coldsweat

Coldsweat is a clean-room Python clone of the [Fever RSS aggregator][f], focusing on providing a compatible API and a simple feed store based on SQLite or MySQL. Coldsweat started as a fork of [Bottle Fever][b] by Rui Carmo. By now I revised most of the code and tested the feed fetcher code with hundreds of Atom and RSS feeds.
Coldsweat is a clean-room Python clone of the [Fever RSS aggregator][f], focusing on providing a compatible API and a simple feed store based on SQLite or MySQL.

Coldsweat started as a fork of [Bottle Fever][b] by Rui Carmo. By now I revised most of the code and tested the feed fetcher code with hundreds of Atom and RSS feeds.

![Screenshot](http://lab.passiomatic.com/coldsweat/images/coldsweat-screenshot.jpg)

Expand All @@ -13,10 +15,10 @@ There will be blood.
## Target features

* Multi-user support
* Compatible with Reeder app on iOS
* Compatible with existing Fever desktop and mobile clients
* Support for grouping of similar items
* Web interface to read, add and import feeds
* Multiprocessing for parallel feed fetching
* Web interface to read, add and import feeds

## Technical underpinnings

Expand All @@ -26,7 +28,7 @@ There will be blood.

## Current status

Coldsweat correctly syncs read and saved items with Reeder for iOS — see issue #3 for more information. A command-line utility is provided to import existing feeds as an OPML file, create users and store new feed entries in the database.
Coldsweat correctly syncs read and saved items with [Reeder][r] for iOS and [ReadKit][rk] on OS X — see issue #3 for more information. A command-line utility is provided to import existing feeds as an OPML file, create users and store new feed entries in the database.

## Setup

Expand All @@ -37,4 +39,6 @@ See <https://github.com/passiomatic/coldsweat/wiki/Setup>
[fp]: https://pypi.python.org/pypi/feedparser/
[f]: http://www.feedafever.com/
[s]: https://github.com/passiomatic/coldsweat
[b]: https://github.com/rcarmo/bottle-fever
[b]: https://github.com/rcarmo/bottle-fever
[rk]: http://readkitapp.com/
[r]: http://reederapp.com/

0 comments on commit b412a77

Please sign in to comment.