From 8d52faf85250b73f7c35ff149e715edc6197614c Mon Sep 17 00:00:00 2001
From: Sam Yaple <sam@yaple.net>
Date: Thu, 12 Jan 2017 01:23:10 +0000
Subject: [PATCH] Update docs

---
 README.md | 52 +++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 51 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index d0925b8..97ace1e 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,51 @@
-# docker-glance
\ No newline at end of file
+# OpenStack yaodu/glance
+[![Docker Automated buil](https://img.shields.io/docker/automated/yaodu/glance.svg)](https://hub.docker.com/r/yaodu/glance/)
+
+Yaodu/glance is a set of Dockerfiles that builds lightweight deployment agnostic images for OpenStack Keystone.
+
+Images are built in the Docker Hub automatically on each push to the master branch to provide a continuously updated set of images based on a number of distributions. Additionally, this repo may be cloned and used to build images for OpenStack Keystone either for development purposes or as part of a CI/CD workflow.
+
+
+## Building locally
+It's really easy to build images locally for the distro of your choice. To clone the repo and build run the following:
+``` bash
+$ git clone https://github.com/yaodu/docker-glance.git
+$ cd ./docker-glance
+$ docker build dockerfiles \
+  --file dockerfiles/Dockerfile-debian \
+  --tag yaodu/glance:latest
+```
+You can, of course, substitute `debian` with your distro of choice.
+
+For more advanced building you can use docker build arguments to define:
+  * The git repo containing the OpenStack project the container should contain, `GIT_REPO`
+  * The git ref the container should use when building, `GIT_REF`
+  * The git repo the container should use when building from a git ref, `GIT_REF_REPO`
+  * The docker image name to use for the base requirements python wheels, `DOCKER_REPO`
+  * The docker image tag to use for the base requirements python wheels, `DOCKER_TAG`
+  * If present, rather than using a docker image containing OpenStack requirements a tarball will be used from the defined URL, `WHEELS`
+
+This makes it really easy to integrate Yaodu images into your development or CI/CD workflow, for example, if you wanted to build an image from [this PS](https://review.openstack.org/#/c/418167/) you could run:
+``` bash
+$ docker build dockerfiles \
+  --file dockerfiles/Dockerfile-ubuntu \
+  --tag mydockernamespace/glance-testing:418167-1 \
+  --build-arg GIT_REPO=http://git.openstack.org/openstack/glance.git \
+  --build-arg GIT_REF_REPO=http://git.openstack.org/openstack/glance.git \
+  --build-arg GIT_REF=refs/changes/67/418167/1
+```
+
+
+## Customizing
+The images should contain all the required assets for running the service. But if you wish or need to customize the `yaodu/glance` image that's great! We hope to have built the images to make this as easy and flexible as possible. To do this we recommend that you perform any required customisation in a child image using a pattern similar to:
+
+``` Dockerfile
+FROM yaodu/glance:latest
+MAINTAINER you@example.com
+
+RUN set -x \
+    && apt-get update \
+    && apt-get install -y --no-install-recommends \
+    your-awesome-binary-package \
+    && rm -rf /var/lib/apt/lists/*
+```