Skip to content

Commit

Permalink
better README
Browse files Browse the repository at this point in the history
  • Loading branch information
julien51 committed Apr 7, 2012
1 parent 3c1cc92 commit 62ebc57
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
# Superpipes

This is a [Yahoo! Pipes](http://pipes.yahoo.com/pipes/) equivalent built with [Superfeedr](http://superfeedr.com/), hosted on [Heroku](http://www.heroku.com/). We built that just in case Y! decides to "sunset" pipes as well...

Here is what it does:

* Agregate feeds
* Displays the agregate (Atom, Json or HTML)

Also, it's realtime, and can be tweaked in any way you want to fit your needs!


Expand All @@ -9,8 +15,9 @@ Also, it's realtime, and can be tweaked in any way you want to fit your needs!
You need:

* One [Heroku](http://www.heroku.com/) account
* To configure the [Redis To Go Addon](https://addons.heroku.com/redistogo)
* To configure the [Superfeedr Addon](https://addons.heroku.com/superfeedr). *Only available to beta testers*
* The [Redis To Go Addon](https://addons.heroku.com/redistogo)
* The [Superfeedr Addon](https://addons.heroku.com/superfeedr). *Only available to beta testers*
* A basic Javascript knowledge to configure the whole thing.

### Clone

Expand All @@ -25,6 +32,7 @@ You need:

* Use https to susbcribe
* Implement signatures to verify origin of content (we can use a secret set in the heroku:config for example.)
* Add *filters* that can be applied to a feed, in the form of function called on each entry.
* Support for multiple agregates
* Make sure we do not depend on the feed's order in the config file!
* Add an HTML view (with a socket.io backend?)
Expand Down

0 comments on commit 62ebc57

Please sign in to comment.