fill out readme a bit, add CI build status icons

Author: dylemma

readme.md

@@ -1,3 +1,7 @@
+[![Build status](https://ci.appveyor.com/api/projects/status/bvfw8fsuy2tt27tl?svg=true)](https://ci.appveyor.com/project/dylemma/codedx-cli-client)
+[![Build status](https://api.travis-ci.org/codedx/codedx-cli-client.svg?branch=master)](https://travis-ci.org/codedx/codedx-cli-client)
+
+
 This is a utility intended to make it easier to interact with 
 [Code Dx's REST API](https://codedx.com/Documentation/APIGuide.html) from the command line.
 
@@ -8,6 +12,11 @@ Currently only a couple API actions are supported, but more may come with demand
 The program runs as a [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop).
 Start it by providing the connection information (Code Dx "base url", and username+password or API Key):
 
+```text
+$> ./codedx-client https://localhost/codedx -u johndoe -p supersecret
+codedx>
+```
+
 ```text
 $> ./codedx-client https://localhost/codedx --api-key 8e218b38-fcdd-453d-8f78-185f7d1d9fa7
 codedx>
@@ -17,6 +26,20 @@ Once in the REPL, type `help` (and hit Enter) for a list of commands.
 You can exit the REPL by typing `exit` or `quit`, or with <kbd>Ctrl+C</kbd> or sending an EOF signal.
 You can learn more about a command by typing `help <command name>` e.g. `help analyze`.
 
+For any command that takes arguments, each argument should be space-separated.
+Arguments that contain spaces should be surrounded with quotes e.g. `'this is one argument'` or `"so is this"`.
+Arguments surrounded with quotes treat backslash (`\`) as an escape character. 
+This means if you have a quoted argument that has a backslash or another quote, it needs a backslash in front of it, e.g. `"a \"quote\" inside"` or `"C:\\my data\\source\\files.zip"`.
+
+Note that you can usually get around needing to escape anything by being clever: 
+ - For file paths with backslashes, just use forward slashes (`/`) instead, e.g. `"C:/my data/source/files.zip"`.
+ - For arguments with quotes in them, surround them with the other type of quote, e.g. `'a "quoted" string'`
+
+If you see an error message like "The filename, directory name, or volume label syntax is incorrect.", 
+you likely used backslashes (`\`) without escaping them (`\\`) inside a quoted argument.
+
+# Example
+
 You're probably here because you're trying to configure your CI environment to send files to Code Dx for analysis.
 For this, you'll want the `analyze` command.
 You can find more details about the `analyze` command by entering `help analyze` in the REPL, but here's an example:
@@ -40,14 +63,3 @@ You can optionally set the name of the analysis with the `--name` flag.
 The `analyze` command saves the effort of putting together a complex `curl` request for the initial file upload,
 setting up a separate request to set an analysis name,
 and setting up a polling loop to wait for the analysis "job" to complete.
-
-> A note about command arguments inside the REPL:
-> 
-> Each argument is separated by a space. If the argument itself needs to have a space in it (e.g. for file paths),
-> you must surround it with quotes (single `'` or double `"`). Within a quoted argument, the backslash character (`\`) 
-> is used as the "escape", e.g. so that if you have another quote or a backslash in the argument (common with windows
-> paths), you'll need to escape it e.g. `"C:\\path\\to\\some\\files.zip"` or just use forward slashes
-> e.g. `"C:/path/to/some/files.zip"`.
->
-> If you see a message like "The filename, directory name, or volume label syntax is incorrect.", you likely used
-> backslashes (`\`) without escaping them (`\\`) inside a quoted argument.