Docker test scripts & Readme

* Update scripts for build and run
* How to use readme additions

README.md

@@ -1,5 +1,84 @@
 # Apidoc Mock
 
-Use [apidoc](http://apidocjs.com/) comments to create a mock server.
+Use [apidoc](http://apidocjs.com/) comments to create a mock server. Quick handy way to generate
+a mock server response.
 
+## Requirements
+The basic requirements:
+ * [Docker](https://docs.docker.com/engine/installation/)
+ * Optionally your system could be running 
+    - [NodeJS version 8+](https://nodejs.org/), (the examples are based off NodeJS)
+    - [Yarn 1.5+](https://yarnpkg.com), otherwise NPM should be adequate.
+
 
+## Use
+
+Generate a "happy path" mock server from [apidoc](http://apidocjs.com/) `@apiSucceessExample` annotations. Once the
+server is setup correctly you should be able update your code comments/annotations and have the mock(s) update with a 
+browser refresh.
+
+### Basic example
+
+The base Docker image comes preloaded with a "hello/world" example, the basics
+
+  ```shell
+    $ docker pull cdcabrera/apidoc-mock
+    $ docker stop mock-api-test
+    $ docker run -i --rm -p 8000:8000 --name mock-api-test cdcabrera/apidoc-mock
+  ```
+
+From there you should be able to navigate to
+- the docs, http://localhost:8000/docs/
+- the example api, http://localhost:8000/hello/world/
+
+
+### Using within a project
+
+1. Setup your API annotations first. `@apiSucceessExample` is the only apiDoc example currently implemented.
+    ```js
+      /**
+       * @api {get} /hello/world/
+       * @apiSuccess {String} foo
+       * @apiSuccess {String} bar
+       * @apiSuccessExample {json} Success-Response:
+       *     HTTP/1.1 200 OK
+       *     {
+       *       "foo": "hello",
+       *       "bar": "world",
+       *     }
+       */
+      const getExample = () => {};
+
+      /**
+       * @api {post} /hello/world/
+       * @apiHeader {String} Authorization Authorization: Token AUTH_TOKEN
+       * @apiSuccess {String} foo
+       * @apiSuccess {String} bar
+       * @apiSuccessExample {json} Success-Response:
+       *     HTTP/1.1 200 OK
+       *     {
+       *       "foo": "hello",
+       *       "bar": "world",
+       *     }
+       */
+      const postExample = () => {};
+    ```
+
+1. Next, make sure Docker is running, and pull in the Docker image, you can use a set of NPM scripts in `package.json`
+    ```js
+      "scripts": {
+        "mock:setup": "docker pull cdcabrera/apidoc-mock",
+        "mock:run": "docker stop mock-api-test; docker run -i --rm -p [YOUR PORT]:8000 -v \"$(pwd)[PATH TO YOUR JS FILES]:/app/data\" --name mock-api-test cdcabrera/apidoc-mock"
+      }
+    ```
+   You'll need to pick a port like... `-p 8000:8000` and a directory path to pull the apiDoc code comments/annotations from like... `-v \"$(pwd)/src:/app/data\"`.
+
+1. Next run the scripts
+    ```shell
+      $ npm run mock:setup
+      $ npm run mock:run
+    ```
+    
+   From there navigate to
+   - the docs, http://localhost:[YOUR PORT]/docs/
+   - the api, http://localhost:[YOUR PORT]/[PATH TO API ENDPOINT]

package.json

@@ -17,8 +17,8 @@
   },
   "main": "src/index.js",
   "scripts": {
-    "docker:run": "docker run -i --rm -p 8080:8000 --name mock-api apidoc-mock",
-    "docker:build": "docker build -t apidoc-mock .",
+    "docker:run": "docker stop mock-api-test; docker run -i --rm -p 8080:8000 -v \"$(pwd)/data:/app/data\" --name mock-api-test apidoc-mock-test",
+    "docker:build": "docker build -t apidoc-mock-test .",
     "serve": "node src/index.js",
     "test": "eslint ./src/",
     "build": "apidoc -i ./data -o ./docs",