Adds usage instructions - resolves #2 (#8)

Author: Haroon Sheikh

Dockerfile

@@ -17,18 +17,15 @@ ARG GAUGE_VERSION
 ENV GAUGE_VERSION $GAUGE_VERSION
 ENV GAUGE_ARCHIVE gauge-$GAUGE_VERSION-linux.x86_64.zip
 
-RUN \
+RUN wget -qnc "https://github.com/getgauge/gauge/releases/download/v$GAUGE_VERSION/$GAUGE_ARCHIVE" && \
   # example release url https://github.com/getgauge/gauge/releases/download/v1.0.0/gauge-1.0.0-linux.x86_64.zip
-  wget -qnc "https://github.com/getgauge/gauge/releases/download/v$GAUGE_VERSION/$GAUGE_ARCHIVE" && \
   unzip $GAUGE_ARCHIVE -d /usr/local/bin && \
   rm -rf $GAUGE_ARCHIVE && \
   # install gauge plugins
   gauge install java && \
   gauge install html-report && \
   gauge install xml-report && \
-  gauge install spectacle && \
-  gauge install flash && \
-  gauge -v
+  gauge install spectacle && gauge -v
 
 WORKDIR /usr/src/app
 ENTRYPOINT ["/usr/local/bin/mvn-entrypoint.sh"]

README.md

@@ -8,7 +8,40 @@ The docker image tagging is based on the [version of Gauge](https://github.com/g
 
 ## Usage
 
-* TODO
+Pull the latest Image with
+
+```bash
+docker pull sitture/docker-gauge-java:latest
+```
+
+### Using `docker run`
+
+```bash
+docker run -it --rm sitture/docker-gauge-java:latest gauge -v
+```
+
+When using maven, you can mount the maven `.m2` repository in the container:
+
+```bash
+docker run -it --rm -v ~/.m2:/root/.m2 sitture/docker-gauge-java:latest mvn --version
+```
+
+You can add additional volumes for your test reports, etc.
+
+### Using `docker-compose.yml`
+
+Example:
+
+```yaml
+services:
+    gauge:
+      image: sitture/docker-gauge-java:latest
+      container_name: docker-gauge-java
+      volumes:
+        - '.:/usr/src/app'
+        - '/Users/${USER}/.m2:/root/.m2'
+      command: gauge -v
+```
 
 ## Issues & Contributions
 

docker-compose.yml

@@ -4,4 +4,8 @@ services:
       build: .
       container_name: docker-gauge-java
       environment:
-        - GAUGE_VERSION=${GAUGE_VERSION}
+        - GAUGE_VERSION=${GAUGE_VERSION}
+      volumes:
+        - '.:/usr/src/app'
+        - '/Users/${USER}/.m2:/root/.m2'
+      command: gauge -v