Permalink
Browse files

amend docs

  • Loading branch information...
1 parent 9e0e741 commit 41c2348a9b7ac939a0242b642d66c9b8c137219e @siuying committed Mar 22, 2010
Showing with 71 additions and 4 deletions.
  1. +60 −0 README.rdoc
  2. +11 −4 README.txt
View
@@ -0,0 +1,60 @@
+= Tappy
+
+== DESCRIPTION:
+
+Twitter API Proxy in ruby.
+
+This is written to filter annoying twitter messages created by Foursquare.
+
+This app is in alpha quality, do not try it at home unless you can figure it out yourself, thank you!
+
+== REQUIREMENTS:
+
+* sinatra
+* typhoeus
+* json
+
+== INSTALL:
+
+* sudo gem install tappy
+
+== USAGE:
+
+* If you do not know what is "Twitter API", this app cannot help you, sorry.
+
+* To filter twitter client "foursquare", run this in command line:
+ tappy 0.0.0.0 3000 "foursquare"
+* Then use your entered IP and port as the twitter API proxy in your twitter client.
+
+* To try out Tappy, use "tappy.heroku.com" as twitter API proxy in your twitter
+client. Note this is for demo purpose only, and will probably not working due
+to rate limitation.
+
+== DEVELOPERS:
+
+* Francis Chong, francis at ignition dot hk
+
+== LICENSE:
+
+The MIT License
+
+Copyright (c) 2010 Francis Chong
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
@@ -4,7 +4,7 @@
Twitter API Proxy in ruby.
-This is written to filter annoying twitter message created by Foursquare.
+This is written to filter annoying twitter messages created by Foursquare.
This app is in alpha quality, do not try it at home unless you can figure it out yourself, thank you!
@@ -20,8 +20,15 @@ This app is in alpha quality, do not try it at home unless you can figure it out
== USAGE:
-* To filter twitter client "foursuqare"
-** tappy 0.0.0.0 3000 "foursuqare"
+* If you do not know what is "Twitter API", this app cannot help you, sorry.
+
+* To filter twitter client "foursquare", run this in command line:
+ tappy 0.0.0.0 3000 "foursquare"
+* Then use your entered IP and port as the twitter API proxy in your twitter client.
+
+* To try out Tappy, use "tappy.heroku.com" as twitter API proxy in your twitter
+client. Note this is for demo purpose only, and will probably not working due
+to rate limitation.
== DEVELOPERS:
@@ -31,7 +38,7 @@ This app is in alpha quality, do not try it at home unless you can figure it out
The MIT License
-Copyright (c) 2010 Ignition Soft Limited
+Copyright (c) 2010 Francis Chong
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the

0 comments on commit 41c2348

Please sign in to comment.