========
Download
========
-The `github releases page <https://github.com/cweiske/shpub/releases>`_
-has self-contained ``.phar`` files that have all dependencies included.
+shpub is released as self-contained ``.phar`` file that includes
+all dependencies.
+
+.. LATESTRELEASE
+
+See `shpub downloads page <http://cweiske.de/shpub-download.htm>`_
+for all released versions.
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>`_
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
__ 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
============
===========
About shpub
===========
+shpub's homepage is http://cweiske.de/shpub.htm
+
Source code
===========