request-feed-update.php

[stapibas.git] / README.rst

diff --git a/README.rst b/README.rst
index 9fff7c4e322afc1d5d8423d21b6e718e4b68c2fd..47954d07330430703dfdfb9df620c58572c4c845 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -2,3 +2,40 @@
 stapibas
 ********
 The standalone Pingback server, written in PHP.
+
+
+
+=================
+Pingback receiver
+=================
+stapibas receives pingbacks for your website and puts them into a database.
+
+
+Setup
+=====
+Let your website send out the following HTTP header::
+
+  X-Pingback: http://stapibas.example.org/xmlrpc.php
+
+That's all.
+
+
+===============
+Pingback sender
+===============
+stapibas is able to send pingbacks out to other websites at behalf of
+your website.
+
+It does this by watching your website's Atom feed.
+Whenever it changes, it fetches the articles that are new or got updated and
+sends out pingbacks to the remote websites.
+
+
+Setup
+=====
+Insert your feed URL in the ``feeds`` database table.
+
+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