Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ccremer committed Nov 18, 2019
1 parent 7d91846 commit d2d2368
Showing 1 changed file with 22 additions and 4 deletions.
26 changes: 22 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,33 @@
# Image Cleanup Client

## General

The image cleanup client is used to clean up Docker images in a Docker Registry when they are tagged using git SHA.

This helps to save space because not anymore needed images are being removed from the registry.
This helps to save space because obsolete images are being removed from the registry.

The respective licenses for attribution are placed in `/attribution`.

## Development
Build and run:

### Requirements

* go 1.13 (`sudo snap install --classic go`)
* goreleaser (`sudo snap install --classic goreleaser`)

### Build

```
goreleaser --snapshot --rm-dist
```

### Test

```
go test ./...
```

### Run
```
go build -o client
./client
./dist/image-cleanup_linux_amd64/image-cleanup --help
```

0 comments on commit d2d2368

Please sign in to comment.