Mercurial > rsstweet

annotate README.md @ 24:c1783bab9035

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