aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Weiske <cweiske@cweiske.de>2020-03-03 17:23:15 +0100
committerChristian Weiske <cweiske@cweiske.de>2020-03-03 17:23:15 +0100
commitd0bd8743b248b291ba8a1656f225cb58cda4dea3 (patch)
tree9f8ba54eb4df9096fa08c1d89eae22f0a79d5308
parent673b1ebc59670f9f5e38428a30826ee67725ac3e (diff)
downloadphinde-d0bd8743b248b291ba8a1656f225cb58cda4dea3.tar.gz
phinde-d0bd8743b248b291ba8a1656f225cb58cda4dea3.zip
Document subscribing to websub topics
-rw-r--r--README.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 071f42d..2e00218 100644
--- a/README.rst
+++ b/README.rst
@@ -144,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
============