diff README.md @ 17:6718f51b34b5

Add readme, copied off original app.
author edogawaconan <me@myconan.net>
date Fri, 05 Sep 2014 20:40:50 +0900
parents
children b82d86b74636
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Fri Sep 05 20:40:50 2014 +0900
@@ -0,0 +1,48 @@
+rsstweet
+========
+
+Twitter removed their v1.0 API and thus completely disables access to tweets
+using RSS readers.
+
+This application will proxy user's tweets into atom feed which solves the
+problem.
+
+Installation
+------------
+
+    hg clone ...
+    cd ... && bundle
+    export ...
+    bin/rails s
+
+Detailed instruction is left as an exercise unless someone step up and write
+one for me.
+
+Configuration
+-------------
+
+This application depends on four Twitter-related tokens:
+
+- `RT_CONSUMER_KEY`
+- `RT_CONSUMER_SECRET`
+- `RT_OAUTH_TOKEN`
+- `RT_OAUTH_TOKEN_SECRET`
+
+Make sure to set them before using.
+
+License
+-------
+
+    Copyright 2014 edogawaconan <me@myconan.net>
+
+    Permission to use, copy, modify, and/or distribute this software for any
+    purpose with or without fee is hereby granted, provided that the above
+    copyright notice and this permission notice appear in all copies.
+
+    THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+    WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+    MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+    ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+    ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.