Add documentation about how to use via docker image (#20)

apache · Jan 12, 2021 · 9bd5feb · 9bd5feb
1 parent 6a614d8
commit 9bd5feb
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/Dockerfile b/Dockerfile
@@ -16,6 +16,8 @@
 # under the License.
 #
 
+# TODO: minimize the docker image size, now 524MB !!!
+
 FROM golang:1.14.3-alpine AS build
 
 WORKDIR /license-eye

diff --git a/README.md b/README.md
@@ -41,6 +41,13 @@ header:
 
 **NOTE**: The full configurations can be found in [the configuration section](#configurations).
 
+### Docker Image
+
+```shell
+$ docker run -it --rm -v $(pwd):/github/workspace apache/skywalking-eyes header check
+$ docker run -it --rm -v $(pwd):/github/workspace apache/skywalking-eyes header fix
+```
+
 ### Compile from Source
 
 ```bash
@@ -119,7 +126,6 @@ ERROR failed to identify the licenses of following packages:
 gopkg.in/yaml.v3
 ```
 
-
 ## Configurations
 
 ```yaml