Improve readme master github/master
authorChristian Weiske <cweiske@cweiske.de>
Thu, 22 Mar 2018 20:15:24 +0000 (21:15 +0100)
committerChristian Weiske <cweiske@cweiske.de>
Thu, 22 Mar 2018 20:15:24 +0000 (21:15 +0100)
Resolves: https://github.com/cweiske/stapibas/issues/3

.gitignore
README.rst

index c1892ca..457fc5d 100644 (file)
@@ -3,3 +3,4 @@ www/test.htm
 lib/*
 /dist/
 /bin/phar-stapibas.php
+/README.html
\ No newline at end of file
index 22ffb07..97322e8 100644 (file)
@@ -1,38 +1,24 @@
 ********
 stapibas
 ********
-The standalone Pingback server, written in PHP.
+The standalone Linkback server, written in PHP.
 
-- Receives linkbacks (webmention and pingbacks)
+- Receives linkbacks (`webmention`__ and `pingbacks`__)
 - Watches your website's Feed to send out linkbacks to all linked URLs
 
-Alternative to `Trackback ‘em All`__
+Alternative to `Trackback ‘em All`__ and `Telegraph`__
 
+__ https://www.w3.org/TR/webmention/
+__ http://www.hixie.ch/specs/pingback/pingback
 __ http://scott.yang.id.au/code/trackback-em-all/
-
-
-============
-Dependencies
-============
-- PHP 5.3+
-- PDO
-- `Console_CommandLine`__
-- `Net_URL2`__
-- `HTTP_Request2`__
-- `PEAR2 Services_Linkback`__
-- `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_Linkback
-__ http://simplepie.org/
+__ https://telegraph.p3k.io/
 
 
 =================
-Pingback receiver
+Linkback receiver
 =================
-stapibas receives pingbacks for your website and puts them into a database.
+stapibas receives linkbacks (webmentions + pingbacks) for your website
+and puts them into a database.
 
 It also sends them as email to a configured address.
 
@@ -42,24 +28,42 @@ Setup
 Let your website send out the following HTTP headers::
 
   X-Pingback: http://stapibas.example.org/xmlrpc.php
-  Header set Link '<http://stapibas.example.org/xmlrpc.php>; rel="webmention"'
+  Link: '<http://stapibas.example.org/xmlrpc.php>; rel="webmention"'
+
+In Apache you can do this with the following configuration::
+
+  Header set X-Pingback "http://stapibas.example.org/xmlrpc.php"
+  Header append Link '<http://stapibas.example.org/xmlrpc.php>; rel="webmention"'
+    
 
 Now, whitelist your domain in the database:
 Add an ``lt_url`` of ``https://example.org/%`` in the ``linkbacktargets`` table.
 
 That's all.
 
+.. note::
+   stapibas does not display the linkbacks in any way - you have to do this yourself.
+
+   If you're looking for a ready-made solution, look at the tools listed
+   on https://indieweb.org/Webmention
+
+
 
 ===============
-Pingback sender
+Linkback sender
 ===============
-stapibas is able to send pingbacks out to other websites at behalf of
+stapibas is able to send linkbacks out to other websites at behalf of
 your website.
 
 It does this by watching your website's Atom (or RSS) feed.
 Whenever it changes, it fetches the articles that are new or got updated and
 sends out pingbacks to the remote websites.
 
+It only works on links that are inside an ``e-content`` section
+that itself has to be inside a `h-entry`__.
+
+__ http://microformats.org/wiki/h-entry
+
 
 Setup
 =====
@@ -74,6 +78,11 @@ HTTP POST request, sending the feed URL::
 
 This tells stapibas to check this feed the next time the pinger runs.
 
+.. note::
+   stapibas does not check itself if the feed changed!
+
+   You need to notify it manually.
+
 
 Run the pinger
 ==============
@@ -83,3 +92,22 @@ extract new URLs from the feed and send pingbacks to them.
 ::
 
    $ php bin/stapibas
+
+============
+Dependencies
+============
+- PHP 5.3+
+- PDO
+- `Console_CommandLine`__
+- `Net_URL2`__
+- `HTTP_Request2`__
+- `PEAR2 Services_Linkback`__
+- `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_Linkback
+__ http://simplepie.org/
+