container: pre-built Vagrant box and docker container
Change-Id: Id49a6426f52fd3e22a94fee4607b7e2a6d0a7454
diff --git a/docker/README.md b/docker/README.md
new file mode 100644
index 0000000..db48f9e
--- /dev/null
+++ b/docker/README.md
@@ -0,0 +1,47 @@
+
+[comments]: The original author of Mini-NDN docker is Md Ashiqur Rahman (marahman@email.arizona.edu)
+
+| :exclamation: Mini-NDN docker is in experimental phase, it uses older version of Mini-NDN and is incompatible with the current version |
+|-----------------------------------------------------------------------------------------------------------------------------------------|
+
+### `docker build` or `docker pull`
+
+The [Dockerfile](https://github.com/ashiqopu/docker-minindn/blob/master/Dockerfile) can be used directly to `build` an image from scratch.
+
+* Build with `Dockerfile`:
+ * Open terminal and use the following command:
+ ```bash
+ git clone https://github.com/ashiqopu/docker-minindn
+ cd docker-minindn
+ ```
+ * Type and enter.
+ ```bash
+ docker build -t minindn .
+ ```
+ * You can then access the container through shell with,
+ ```bash
+ docker run -m 4g --cpus=4 -it --rm --privileged \
+ -v /lib/modules:/lib/modules \
+ minindn bin/bash
+ ```
+
+* Pull from hub:
+ * Open a terminal and type:
+ ```bash
+ docker pull marahman/minindn:v0.2
+ ```
+
+ * You can then access the container through shell with,
+ ```bash
+ docker run -m 4g --cpus=4 -it --rm --privileged -e DISPLAY \
+ -v /tmp/.X11-unix:/tmp/.X11-unix \
+ -v /lib/modules:/lib/modules \
+ marahman/minindn:v0.2 bin/bash
+ ```
+
+### Notes:
+
+* Memory (-m), CPU (--cpus) are recommended by Mini-NDN.
+* `--privileged` is mandatory for underlying [Mininet](http://mininet.org/) to utilize virtual switch
+* Root directory on `run` is `/mini-ndn` containing the installation and examples.
+* GUI may not work for now due to docker and xterm setup issues and is independent from Mini-NDN.
\ No newline at end of file