command usage in the readme

ak2consulting · Feb 9, 2012 · 4ca0e04 · 4ca0e04
1 parent 1a17eae
commit 4ca0e04
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 4 deletions.
diff --git a/README.markdown b/README.markdown
@@ -68,8 +68,25 @@ command-line usage
 
 ```
 Usage:
-  seaport port            # to listen
-  seaport host:port show  # to show the port map
+
+  seaport port
+
+    Create seaport server.
+
+  seaport host:port show
+
+    Show the port map from the server at host:port.
+
+  seaport host:port service name@version [COMMAND...]
+
+    Register a service. COMMAND will get an assigned port to use as
+    its last argument. If COMMAND exits it will be restarted.
+
+  seaport host:port query name@version
+
+    Query the server for services matching the name@version pattern.
+    The version may contain semver patterns to specify a range.
+    Prints out a JSON array of host:port strings.
 ```
 
 methods

diff --git a/bin/cli.js b/bin/cli.js
@@ -17,8 +17,8 @@ var argv = require('optimist')
         '',
         '  $0 host:port service name@version [COMMAND...]',
         '',
-        '    Register a service. COMMAND will get an assigned port to use as'
-            + ' its last argument. If COMMAND exits it will be restarted.',
+        '    Register a service. COMMAND will get an assigned port to use as',
+        '    its last argument. If COMMAND exits it will be restarted.',
         '',
         '  $0 host:port query name@version',
         '',