update readme
authorChristian Weiske <cweiske@cweiske.de>
Tue, 6 Sep 2016 22:20:24 +0000 (00:20 +0200)
committerChristian Weiske <cweiske@cweiske.de>
Tue, 6 Sep 2016 22:20:24 +0000 (00:20 +0200)
README.rst

index 5ba8153..09dde4a 100644 (file)
@@ -2,3 +2,47 @@
 shpub - micropub client for your shell
 **************************************
 Command line micropub client written in PHP.
+
+
+=====
+Usage
+=====
+
+Initial setup
+=============
+::
+
+    $ ./bin/shpub.php connect http://mywebsite http://mywebsite/user
+
+If you pass a third parameter, then it will be the name of the connection.
+You can select a specific server/connection with ``-s`` on all commands.
+
+
+List configured servers/connections
+===================================
+::
+
+    $ ./bin/shpub.php server
+    rr
+    test
+    anoweco.bogo
+    local2
+
+Also try ``-v`` which lists server and user URLs.
+
+
+Create a like
+=============
+::
+
+    $ ./bin/shpub.php like http://example.org/
+    Like created at server
+    http://anoweco.bogo/comment/23.htm
+
+Create a reply
+==============
+::
+
+    $ ./bin/shpub.php reply http://example.org/ "Hey, cool!"
+    Reply created at server
+    http://anoweco.bogo/comment/42.htm