Permalink
Browse files

DOCS: Finally wrote a README!

Resolves: #11
  • Loading branch information...
1 parent e2b95c3 commit 5842f1dde8443bfe8b4edf56a0a0c3392388e24b charlie committed Oct 11, 2016
Showing with 24 additions and 3 deletions.
  1. +24 −3 README.md
View
@@ -1,4 +1,25 @@
-twitrssme
-=========
+TwitRSS.me
+==========
-TwitRSS.me code
+[TwitRSS.me](https://twitrss.me) is a web service that let you generate an [RSS feed](https://en.wikipedia.org/wiki/RSS) from your Twitter user timeline, or from a Twitter search.
+
+It does this by connecting to Twitter on the web and screenscraping the data, rather than by using the [Twitter API](https://dev.twitter.com/rest/public).
+
+Installation
+------------
+
+You can install TwitRSS.me by following the instructions in the [INSTALL.md](https://github.com/ciderpunx/twitrssme/blob/master/INSTALL.md) file.
+
+The main reason for doing so is that the caching limits (one query every 45 minutes) is proving restrictive.
+
+History
+-------
+
+You can see a bunch of [TwitRSS.me blog posts](http://charlieharvey.org.uk/tag/twitrss.me/) on Charlie Harvey's site. They mostly deal with me being increasingly freaked out about the amount of traffic that is turning up.
+
+Licence
+-------
+
+The code for TwitRSS.me is released under the GNU GPL licence version 2 (See the LICENSE file) and is copyright of the contributors — Charlie Harvey and Daniel Perelman at time of writing.
+
+The website content is released under [CC-BY-SA](https://creativecommons.org/licenses/by-nc-sa/3.0/) — Charlie Harvey and James Lu at time of writing.

0 comments on commit 5842f1d

Please sign in to comment.