deployment handler initial seed code

Change-Id: I0bfc86d17edead0114ea0012fb469014e978cd15
Issue-Id: DCAEGEN2-43
Signed-off-by: J. F. Lucas <jflucas@research.att.com>

1 files changed, 15 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cb7978c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+### DCAE Deployment Handler
+
+The DCAE Deployment Handler (DH) is the interface to DCAE's orchestration system.  The DH exposes an HTTP-based API that allows client systems to request the deployment of DCAE services based on service blueprints stored in the DCAE inventory, as well to check the status of deployments and to request undeployment of a previously-deployed service.  The API is documented here [here](./dispatcherAPI.yaml)
+
+The diagram below shows the DH's place in the DCAE orchestration system.
+
+![Dh diagram](./dh.png)
+
+
+#### Building the Deployment Handler
+The Deployment Handler is packaged as a Docker image.  The [Dockerfile](./Dockerfile) can drive a Docker build (using the `docker build` command) from the top-level directory of this repository.
+
+To incorporate git information about the current tag and commit into the code, run the `set_version.sh` script to generate a new `version.js` file before doing the Docker build.  (The script uses `git describe --long --always` to get the version information.)
+
+When building an image intended as a release candidate or a released product, it's important to freeze all of the dependencies.  Use the `npm shrinkwrap` command to freeze the dependencies, and commit the resulting `npm-shrinkwrap.json` file.  
\ No newline at end of file