document content-from-file

[shpub.git] / README.rst

diff --git a/README.rst b/README.rst
index 4e1d5485189a3282db33481e6a895bce5b6228af..1ac15c981a4272b41adf50525408640463571ca3 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -24,6 +24,7 @@ When using the git version, you need to have the following dependencies
 installed on your system:
 
 - PHP 5.4+
+- PEAR's `Console_CommandLine <http://pear.php.net/package/Console_CommandLine>`_
 - PEAR's `HTTP_Request2 <http://pear.php.net/package/HTTP_Request2>`_
 - PEAR's `MIME_Type <http://pear.php.net/package/MIME_Type>`_
 - PEAR's `NET_URL2 <http://pear.php.net/package/Net_URL2>`_
@@ -113,6 +114,29 @@ URL image upload::
     Note created at server
     http://known.bogo/2016/img-url
 
+Load note content from a file::
+
+    $ ./bin/shpub.php note - < /path/to/file.txt
+    Note created at server
+    http://known.bogo/2017/some-note
+
+
+Custom post types
+=================
+You may create custom post types with the ``x`` command.
+This is useful if your micropub endpoint supports additional types,
+like known's ``annotation`` type (comments and likes for posts).
+
+Create a comment to a known post::
+
+    $ ./bin/shpub.php x annotation\
+        -x url=http://known.bogo/2016/example-domain-1\
+        -x type=reply\
+        -x username=barryf\
+        -x userurl=http://example.org/~barryf\
+        -x userphoto=http://example.org/~barryf/avatar.jpg\
+        -x content="There is a typo in paragraph 1. 'Fou' should be 'Foo'"
+
 
 ===============
 Delete/Undelete
@@ -139,6 +163,19 @@ Existing posts can be modified if the `server supports this`__::
 __ https://indieweb.org/Micropub/Servers#Implementation_status
 
 
+===================
+Syndication targets
+===================
+You may list the syndication targets defined on the server::
+
+    $ ./bin/shpub.php targets
+    IndieNews
+     https://news.indieweb.org/en
+
+Then specify it when creating a post::
+
+    $ ./bin/shpub.php article -x mp-syndicate-to=https://news.indieweb.org/en title text
+
 ============
 File uploads
 ============