From: Christian Weiske Date: Thu, 13 Jun 2013 22:55:44 +0000 (+0200) Subject: update readme X-Git-Url: https://git.cweiske.de/stapibas.git/commitdiff_plain/2742e3e3e79d55295fafdb81a86eee9b366031d8?hp=59a7003c47ae1f670ae6d779e9e7f124b1dc5b01 update readme --- diff --git a/README.rst b/README.rst index 47954d0..a3e81d7 100644 --- a/README.rst +++ b/README.rst @@ -3,7 +3,25 @@ stapibas ******** The standalone Pingback server, written in PHP. +Alternative to `Trackback ‘em All`__ +__ http://scott.yang.id.au/code/trackback-em-all/ + + +============ +Dependencies +============ +- PHP 5.3+ +- PDO +- `Net_URL2`__ +- `HTTP_Request2`__ +- `PEAR2 Services_Pingback`__ +- `SimplePie`__ + +__ http://pear.php.net/package/Net_URL2 +__ http://pear.php.net/package/HTTP_Request2 +__ https://github.com/pear2/Services_Pingback +__ http://simplepie.org/ ================= Pingback receiver @@ -39,3 +57,13 @@ Whenever you update your website, tell stapibas about it via a HTTP POST request:: $ curl -d url=http://example.org/feed/ http://stapibas.example.org/request-feed-update.php + + +Run the pinger +============== +Run stapibas every 5 minutes or every hour to check for feed updates, +extract new URLs from the feed and send pingbacks to them. + +:: + + $ php bin/stapibas