New documentation for chapter 1

chapter1.md

@@ -53,6 +53,66 @@ Commands:
   help [cmd]     display help for [cmd]
 ```
 
+The cli provides two commands API and behaviors and each command has its own options.
+
+# Behaviors command
+
+Execute `./bin/cli behaviors -b` to build the behaviors made available, using the config file located at the root of the project. 
+
+The built behaviors, along with a behavior metadata file (`behaviorMetadata.js`), can be found in the `dist` directory which will be created for you if it does not exist in the root of this project.
+
+The following options are available to use with the behaviors command:
+
+```
+
+$ ./bin/cli behaviors --help
+
+Usage: cli-behaviors [options]
+
+Options:
+  -V, --version                    output the version number
+  -v, --validate [fileOrDir]       
+  -c, --config [configPath]        Path to the behavior config file (default: "<path to wr-behaviors>/behavior-config.yml")
+  -b, --build [fileOrDir]          Build a behaviors or all behaviors contained within a directory (default: true)
+  -w, --watch [behaviorFileOrDir]  Watch the files, and their imports, in the build directory for re-bundling on changes (placed in dist directory)
+  --metadata [dumpDir]             Generate behavior metadata, optionally supplying a path to directory where metadata is to be placed. Defaults to current working directory
+  -h, --help                       output usage information
+```
+
+
+# API command
+
+To run the behavior API server execute `./bin/cli api --build-behaviors`.
+
+This will start the API server after all behaviors provided by this project have been built.
+
+If you have already built the behaviors using the `behaviors` command provided by the cli then you may omit the `--build-behaviors` flag.
+
+The following options are available to use with the API command:
+
+```
+$ ./bin/cli api --help
+
+Usage: cli-api [options]
+
+Options:
+  -V, --version                        output the version number
+  -p, --port [port]                    The port the api server is to bind to (default: 3030)
+  -h, --host [host]                    The host address the server is listen on (default: "127.0.0.1")
+  -b, --behaviorDir [behaviorDir]      The path to the directory containing the build behaviors (default: "<path to wr-behaviors>/dist")
+  -m, --behaviorMetadata [medataPath]  The path to the behavior metadata (default: "<path to wr-behaviors>/dist/behaviorMetadata.js")
+  --build-behaviors                    Should the api server build the behaviors for starting up
+  -h, --help                           output usage information
+```
+
+Some configuration of the API server can be done via the environment variables listed below
+
+* `BEHAVIOR_API_HOST`: the host the api server will use (e.g. 127.0.0.1)
+* `BEHAVIOR_API_PORT`: the port the api server will listen on (e.g. 3030)
+* `WR_BEHAVIOR_DIR`: path to the directory containing the built behaviors
+* `WR_BEHAVIOR_METADATA_PATH`: path to the behavior metadata file
+* `BUILD_BEHAVIORS`: should the api server build the behaviors before starting
+
 //I can't yet explain how to use autopilot in the browser since the extension isn't finished yet, right? 
 
 ## About Web Traffic