Do not use STDOUT and STDERR constants

[phinde.git] / README.rst

diff --git a/README.rst b/README.rst
index 2e00218488e06335cbbbd7b3d5a8d0a7d989e0c1..cd3641b96d55b1b19e2303ab6bc5761a69f0d3c8 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -36,28 +36,27 @@ Features
 ============
 Dependencies
 ============
 ============
 Dependencies
 ============

-- PHP 5.5+
+- PHP 8.x

 - Elasticsearch 2.0
 - MySQL or MariaDB for WebSub subscriptions
 - Gearman (Debian 9: ``gearman-job-server``, not ``gearman-server``)
 - Elasticsearch 2.0
 - MySQL or MariaDB for WebSub subscriptions
 - Gearman (Debian 9: ``gearman-job-server``, not ``gearman-server``)

+- ``gearadmin`` command line tool (``gearman-tools`` package)

 - PHP Gearman extension
 - PHP Gearman extension

-- Console_CommandLine
-- Net_URL2
-- Twig 1.x
+- Some PHP libraries that get installed with composer

 
 
 =====
 Setup
 =====
 #. Install and run Elasticsearch and Gearman
 
 
 =====
 Setup
 =====
 #. Install and run Elasticsearch and Gearman

-#. Install ``php-gearman``
+#. Install ``php-gearman`` and ``gearman-tools``

 #. Get a local copy of the code::
 
      $ git clone https://git.cweiske.de/phinde.git phinde
 
 #. Install dependencies via composer::
 
 #. Get a local copy of the code::
 
      $ git clone https://git.cweiske.de/phinde.git phinde
 
 #. Install dependencies via composer::
 

-     $ composer install
+     $ composer install --no-dev

 
 #. Point your webserver's document root to phinde's ``www`` directory
 #. Copy ``data/config.php.dist`` to ``data/config.php`` and adjust it.
 
 #. Point your webserver's document root to phinde's ``www`` directory
 #. Copy ``data/config.php.dist`` to ``data/config.php`` and adjust it.


@@ -146,9 +145,9 @@ https://www.elastic.co/guide/en/elasticsearch/plugins/2.0/delete-by-query-usage.
 
 Subscribe to a website/feed
 ===========================
 
 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.
+Phinde supports WebSub__ to get subscribe to changes of a website.
+When phinde gets notified by the website's hub about changes,
+it will immediately crawl and index the changed pages.

 
 Subscribe to a website's feed::
 
 
 Subscribe to a website's feed::
 


@@ -159,6 +158,12 @@ 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.
 
 The status page will show the number of working, and the number of open
 subscriptions.
 

+Unsubscribing also happens on command line::
+
+    $ php bin/unsubscribe.php http://example.org/feed.atom
+
+__ https://www.w3.org/TR/websub/
+

 ============
 About phinde
 ============
 ============
 About phinde
 ============