Andreas/watchtower
1
0
Fork 0
mirror of https://github.com/containrrr/watchtower.git synced 2026-03-12 15:42:35 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

chore(docs): Update docs

Browse source
This commit is contained in:
Jan Rundshagen 2024-07-09 09:22:02 +02:00
parent 7382727c74
commit 156d25ccea
No known key found for this signature in database
GPG key ID: D39ECE260D6616C7
12 changed files with 55 additions and 58 deletions
Download patch file Download diff file Expand all files Collapse all files

31
docs/index.md
View file

@ -1,4 +1,10 @@
<p style="text-align: center; margin-left: 1.6rem;">
> [!NOTE]
> This is a fork of the really nice project from [containrrr](https://github.com/containrrr) called [watchtower](https://github.com/containrrr/watchtower).
>
> I am not the original author of this project. I just forked it to make some changes to it and keep it up-to-date as properly as I can.
>
> Contributions, tips and hints are welcome. Just open an issue or a pull request. Please be aware that I am by no means a professional developer. I am just a Platform Engineer.
<img alt="Logotype depicting a lighthouse" src="./images/logo-450px.png" width="450" />
</p>
<h1 align="center">
@ -8,11 +14,8 @@
<p align="center">
A container-based solution for automating Docker container base image updates.
<br/><br/>
<a href="https://circleci.com/gh/containrrr/watchtower">
<img alt="Circle CI" src="https://circleci.com/gh/containrrr/watchtower.svg?style=shield" />
</a>
<a href="https://codecov.io/gh/containrrr/watchtower">
<img alt="Codecov" src="https://codecov.io/gh/containrrr/watchtower/branch/main/graph/badge.svg">
<a href="https://codecov.io/gh/beatkind/watchtower">
<img alt="Codecov" src="https://codecov.io/gh/beatkind/watchtower/branch/main/graph/badge.svg">
</a>
<a href="https://godoc.org/github.com/beatkind/watchtower">
<img alt="GoDoc" src="https://godoc.org/github.com/beatkind/watchtower?status.svg" />
@ -21,19 +24,13 @@
<img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/beatkind/watchtower" />
</a>
<a href="https://github.com/beatkind/watchtower/releases">
<img alt="latest version" src="https://img.shields.io/github/tag/containrrr/watchtower.svg" />
<img alt="latest version" src="https://img.shields.io/github/tag/beatkind/watchtower.svg" />
</a>
<a href="https://www.apache.org/licenses/LICENSE-2.0">
<img alt="Apache-2.0 License" src="https://img.shields.io/github/license/containrrr/watchtower.svg" />
<img alt="Apache-2.0 License" src="https://img.shields.io/github/license/beatkind/watchtower.svg" />
</a>
<a href="https://www.codacy.com/gh/containrrr/watchtower/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=containrrr/watchtower&amp;utm_campaign=Badge_Grade">
<img alt="Codacy Badge" src="https://app.codacy.com/project/badge/Grade/1c48cfb7646d4009aa8c6f71287670b8"/>
</a>
<a href="https://github.com/beatkind/watchtower/#contributors">
<img alt="All Contributors" src="https://img.shields.io/github/all-contributors/containrrr/watchtower" />
</a>
<a href="https://hub.docker.com/r/containrrr/watchtower">
<img alt="Pulls from DockerHub" src="https://img.shields.io/docker/pulls/containrrr/watchtower.svg" />
<a href="https://hub.docker.com/r/beatkind/watchtower">
<img alt="Pulls from DockerHub" src="https://img.shields.io/docker/pulls/beatkind/watchtower.svg" />
</a>
</p>
@ -50,7 +47,7 @@ the following command:
$ docker run -d \
--name watchtower \
-v /var/run/docker.sock:/var/run/docker.sock \
containrrr/watchtower
beatkind/watchtower
```
=== "docker-compose.yml"
@ -59,7 +56,7 @@ the following command:
version: "3"
services:
watchtower:
image: containrrr/watchtower
image: beatkind/watchtower
volumes:
- /var/run/docker.sock:/var/run/docker.sock
```