add feed/list command, show help when no feed command given

[stapibas.git] / README.rst

diff --git a/README.rst b/README.rst
index 47954d07330430703dfdfb9df620c58572c4c845..108c90cb4e9c8e64a2bd61628ff9bb22382afba6 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -3,7 +3,27 @@ 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
+- `Console_CommandLine`__
+- `Net_URL2`__
+- `HTTP_Request2`__
+- `PEAR2 Services_Pingback`__
+- `SimplePie`__
+
+__ http://pear.php.net/package/Console_CommandLine
+__ 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 +59,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