README: mention the supported sites in the README file
[tweeper.git] / README
1 Tweeper is a web scraper which extracts the most recent public tweets of
2 a given user from their home page on Twitter.com and formats them in RSS, so
3 the information can be conveniently accessed and collected by a feed reader.
4
5 Since Jun 11th 2013 Twitter.com retired their API v1.0, so it's not possible
6 to access a user timeline via RSS anymore, and it's also become mandatory to
7 authenticate via OAuth to access this _public_ information in JSON format:
8
9   https://dev.twitter.com/discussions/16289
10   https://dev.twitter.com/discussions/11564
11
12 Some services came up to overcome this "problem":
13
14   http://twss.55uk.net/
15   http://twitter-rss.com/ (now redirecting to google.com)
16   http://rssitfor.me
17
18 However these solutions are still shady and let no control to the user about
19 who collects the information about the visited user timelines.
20
21 This is why Tweeper[1] was born, as an Open Source way to keep following your
22 friends with a certain degree of anonymity, without having to tell Twitter.com
23 whom you are friend to.
24
25 [1] http://www.urbandictionary.com/define.php?term=TWEEPER&defid=3743173
26
27 Tweeper can easily scrape sites other than Twitter, it is just a matter of
28 writing an xsl stylesheet for the transformation; an example for pump.io
29 activity stream is provided in rss_converter_pump.io.xsl
30
31 The currently supported sites are:
32
33   * Twitter.com
34   * Pump.io based websites, like Identi.ca
35   * Dilbert.com
36   * Howtoons.com
37   * Instagram.com
38
39 Tweeper can be used via web or as a command line program, for example as
40 a filter in your feed reader, by passing the URL of the user's public timeline
41 as the first argument.
42
43 Example of use on the command line:
44
45   $ php tweeper.php http://twitter.com/NSACareers
46
47 Example of use as a Liferea[2] filter:
48
49   $ liferea-add-feed  "|php .../path_to_tweeper/tweeper.php http://twitter.com/NSAcareers"
50
51 Example of use with identi.ca:
52
53   $ liferea-add-feed  "|php .../path_to_tweeper/tweeper.php http://identi.ca/evan"
54
55 [2] http://lzone.de/liferea/
56
57 Tweeper is licensed under the GPLv3.
58 Tweeper was written by Antonio Ospite http://ao2.it