TODO: remove item about duplicated RSS items

[tweeper.git] / README

diff --git a/README b/README
index ea99caf..d2d200b 100644 (file)
--- a/README
+++ b/README
@@ -13,9 +13,10 @@ Some services came up to overcome this "problem":
 
   http://twss.55uk.net/
   http://twitter-rss.com/ (now redirecting to google.com)
+  http://rssitfor.me
 
 However these solutions are still shady and let no control to the user about
-who collects informations about the visited user timelines.
+who collects the information about the visited user timelines.
 
 This is why Tweeper[1] was born, as an Open Source way to keep following your
 friends with a certain degree of anonymity, without having to tell Twitter.com
@@ -23,17 +24,34 @@ whom you are friend to.
 
 [1] http://www.urbandictionary.com/define.php?term=TWEEPER&defid=3743173
 
+Tweeper can easily scrape sites other than Twitter, it is just a matter of
+writing an xsl stylesheet for the transformation; an example for pump.io
+activity stream is provided in rss_converter_pump.io.xsl
+
+The currently supported sites are:
+
+  * Twitter.com
+  * Pump.io based websites, like Identi.ca
+  * Dilbert.com
+  * Howtoons.com
+  * Instagram.com
+  * Facebook.com (public pages)
+
 Tweeper can be used via web or as a command line program, for example as
-a filter in your feed reader, by passing the user's "screen name" (without the
-'@') as the first argument.
+a filter in your feed reader, by passing the URL of the user's public timeline
+as the first argument.
 
 Example of use on the command line:
 
-  $ php tweeper.php NSACareers
+  $ php tweeper.php http://twitter.com/NSACareers
 
 Example of use as a Liferea[2] filter:
 
-  $ liferea-add-feed  "|php .../path_to_tweeper/tweeper.php NSAcareers"
+  $ liferea-add-feed  "|php .../path_to_tweeper/tweeper.php http://twitter.com/NSAcareers"
+
+Example of use with identi.ca:
+
+  $ liferea-add-feed  "|php .../path_to_tweeper/tweeper.php http://identi.ca/evan"
 
 [2] http://lzone.de/liferea/