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