Install phpunit

[phinde.git] / README.rst

diff --git a/README.rst b/README.rst
index cbc259f61a06cd96cf9454b9b76e86fe185fda7e..2e00218488e06335cbbbd7b3d5a8d0a7d989e0c1 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -38,6 +38,7 @@ Dependencies
 ============
 - PHP 5.5+
 - Elasticsearch 2.0
+- MySQL or MariaDB for WebSub subscriptions
 - Gearman (Debian 9: ``gearman-job-server``, not ``gearman-server``)
 - PHP Gearman extension
 - Console_CommandLine
@@ -61,6 +62,7 @@ Setup
 #. Point your webserver's document root to phinde's ``www`` directory
 #. Copy ``data/config.php.dist`` to ``data/config.php`` and adjust it.
    Make sure your add your domain to the crawl whitelist.
+#. Create a MySQL database and import the schema from ``data/schema.sql``
 #. Run ``bin/setup.php`` which sets up the Elasticsearch schema
 #. Put your homepage into the queue::
 
@@ -142,6 +144,21 @@ That's delete-by-query 2.0, see
 https://www.elastic.co/guide/en/elasticsearch/plugins/2.0/delete-by-query-usage.html
 
 
+Subscribe to a website/feed
+===========================
+Phinde supports WebSub to get subscribe to changes of a website.
+When phinde gets notified by the hub about changes, it will
+immediately crawl and index the changed pages.
+
+Subscribe to a website's feed::
+
+    $ php bin/subscribe.php http://example.org/feed.atom
+
+Phinde will determine the website's hub and send a registration request to it.
+
+The status page will show the number of working, and the number of open
+subscriptions.
+
 ============
 About phinde
 ============