Mercurial > rsstweet

comparison README.md @ 17:6718f51b34b5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add readme, copied off original app.
author edogawaconan <me@myconan.net>
date Fri, 05 Sep 2014 20:40:50 +0900
parents
children b82d86b74636
comparison
equal deleted inserted replaced
16:fff788625214 17:6718f51b34b5
1 rsstweet
2 ========
3
4 Twitter removed their v1.0 API and thus completely disables access to tweets
5 using RSS readers.
6
7 This application will proxy user's tweets into atom feed which solves the
8 problem.
9
10 Installation
11 ------------
12
13 hg clone ...
14 cd ... && bundle
15 export ...
16 bin/rails s
17
18 Detailed instruction is left as an exercise unless someone step up and write
19 one for me.
20
21 Configuration
22 -------------
23
24 This application depends on four Twitter-related tokens:
25
26 - `RT_CONSUMER_KEY`
27 - `RT_CONSUMER_SECRET`
28 - `RT_OAUTH_TOKEN`
29 - `RT_OAUTH_TOKEN_SECRET`
30
31 Make sure to set them before using.
32
33 License
34 -------
35
36 Copyright 2014 edogawaconan <me@myconan.net>
37
38 Permission to use, copy, modify, and/or distribute this software for any
39 purpose with or without fee is hereby granted, provided that the above
40 copyright notice and this permission notice appear in all copies.
41
42 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
43 WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
44 MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
45 ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
46 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
47 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
48 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.