Skip to content

Commit 9bd5feb

Browse files
authored
Add documentation about how to use via docker image (#20)
1 parent 6a614d8 commit 9bd5feb

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

Dockerfile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
# under the License.
1717
#
1818

19+
# TODO: minimize the docker image size, now 524MB !!!
20+
1921
FROM golang:1.14.3-alpine AS build
2022

2123
WORKDIR /license-eye

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,13 @@ header:
4141

4242
**NOTE**: The full configurations can be found in [the configuration section](#configurations).
4343

44+
### Docker Image
45+
46+
```shell
47+
$ docker run -it --rm -v $(pwd):/github/workspace apache/skywalking-eyes header check
48+
$ docker run -it --rm -v $(pwd):/github/workspace apache/skywalking-eyes header fix
49+
```
50+
4451
### Compile from Source
4552

4653
```bash
@@ -119,7 +126,6 @@ ERROR failed to identify the licenses of following packages:
119126
gopkg.in/yaml.v3
120127
```
121128

122-
123129
## Configurations
124130

125131
```yaml

0 commit comments

Comments
 (0)