From f990871798a4fdb870e05e8ff7e0350331fc5c84 Mon Sep 17 00:00:00 2001 From: MrMeeb Date: Sat, 27 May 2023 16:46:47 +0000 Subject: [PATCH] updated readme [CI SKIP] --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6f56c32..964360f 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,20 @@ # Cronicle Docker +![Drone (self-hosted) with branch](https://img.shields.io/drone/build/MrMeeb/cronicle-docker/main?label=main&server=https%3A%2F%2Fdrone.mrmeeb.stream&style=for-the-badge) ![Drone (self-hosted) with branch](https://img.shields.io/drone/build/MrMeeb/cronicle-docker/develop?label=develop&server=https%3A%2F%2Fdrone.mrmeeb.stream&style=for-the-badge) + Dockerised Cronicle, based on the [Cronicle-Edge](https://github.com/cronicle-edge/cronicle-edge) fork. Can function in both the **manager** and **worker** role. +## Tags + +|Tag |Description| +|-------|-----------| +|latest |Latest image built from the main branch. Usually coincides with a tagged release.| +|develop|Latest image built from the develop branch. Commits are made to the develop branch before being merged to main. Old versions of `develop` are removed after 14 days.| + +Tags relating to releases are also available, for locking in on a specific version. + ## Running `config.json`, located in `/config/cronicle/conf/config.json`, is automatically generated on the first run of Cronicle in 'manager' mode. This file must be kept identical between the manager and any workers it controls. @@ -68,4 +79,4 @@ This container automatically checks for scripts in `/config/init` and runs them |MODE |manager, worker|manager|Determines what mode Cronicle runs in |PUID |int |1000 |Sets the UID of the user Cronicle runs under |PGID |int |1000 |Sets the GID of the user Cronicle runs under -|TZ |[List of valid TZs](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) |UTC |Sets the timezone of the container and by extension Cronicle \ No newline at end of file +|TZ |[List of valid TZs](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) |UTC |Sets the timezone of the container and by extension Cronicle