Sanitise README

This commit is contained in:
Kai Hendry
2013-07-14 21:07:05 +08:00
parent 06f5cc0225
commit 5868061d45

View File

@@ -1,18 +1,18 @@
# <http://greptweet.com> # <http://greptweet.com>
<a href="http://www.flickr.com/photos/hendry/7577182774/" title="Offline Greptweet on Chrome IOS by Kai Hendry, on Flickr"><img src="http://farm8.staticflickr.com/7133/7577182774_d5b654ea69_m.jpg" width="160" height="240" alt="Offline Greptweet on Chrome IOS"></a> <a href="http://www.flickr.com/photos/hendry/9284645632/" title="Greptweet by Kai Hendry, on Flickr"><img src="http://farm4.staticflickr.com/3790/9284645632_6e5fc45fd9_n.jpg" width="180" height="320" alt="Greptweet"></a>
* Uses [HTML offline feature](http://www.whatwg.org/specs/web-apps/current-work/multipage/offline.html) * Uses [HTML offline feature](http://www.whatwg.org/specs/web-apps/current-work/multipage/offline.html)
* Aims to [suck less](http://suckless.org) by keeping lines of code low * Aims to [suck less](http://suckless.org) by keeping lines of code low
* Encourage folks to use `fetch-tweets.sh` themselves and get into shell ;) * Encourage folks to use `fetch-tweets.sh` themselves and get into shell ;)
* Dependencies: curl, libhtml-parser-perl (to decode HTML entities), xmlstarlet, coreutils, PHP * Dependencies: PHP, curl
* Look and feel mostly by <http://twitter.github.com/bootstrap> * Look and feel by <http://twitter.github.com/bootstrap>
* **Please** review and comment on the code! * **Please** review and comment on the code!
# Known limitations # Known limitations
* API only allows 3200 tweets to be downloaded this way :(( * API only allows 3200 tweets to be downloaded this way :(
* 150 API limit on the server ... (so clone it and use it yourself!) * 300 API limit using [Application only Auth](https://dev.twitter.com/docs/auth/application-only-auth) bearer token
* Won't work on protected accounts (duh!) * Won't work on protected accounts (duh!)
* No @mentions or DMs from other accounts * No @mentions or DMs from other accounts
@@ -25,17 +25,3 @@ Fetch your tweets manually by accessing the URL:
Last 4 tweets: Last 4 tweets:
curl -s http://greptweet/u/webconverger/tweets.txt | head -n4 curl -s http://greptweet/u/webconverger/tweets.txt | head -n4
# TODO
* Nail these [bugs](https://github.com/kaihendry/Greptweet/issues?state=open)
# Shell script feedback on the Web works by disabling Apache's mod_deflate !
<http://stackoverflow.com/a/9022823/4534>
There is a problem whereby if the page is killed whilst fetching, the lock isn't cleared then and there because `trap` does not seem to work.
Make sure your httpd does utf8 all the time:
AddDefaultCharset utf-8