diff --git a/README.md b/README.md index 5d58856..505399c 100644 --- a/README.md +++ b/README.md @@ -48,26 +48,26 @@ This software is a fork of library and licensed under the GPL v3 License. ## Supported Architectures -Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). +We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). -Simply pulling `lscr.io/linuxserver/calibre-web` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. +Simply pulling `lscr.io/linuxserver/calibre-web:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. The architectures supported by this image are: -| Architecture | Tag | -| :----: | --- | -| x86-64 | amd64-latest | -| arm64 | arm64v8-latest | -| armhf | arm32v7-latest | +| Architecture | Available | Tag | +| :----: | :----: | ---- | +| x86-64 | ✅ | amd64-\ | +| arm64 | ✅ | arm64v8-\ | +| armhf| ✅ | arm32v7-\ | ## Version Tags -This image provides various versions that are available via tags. `latest` tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them. +This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags. -| Tag | Description | -| :----: | --- | -| latest | Releases of Calibre-Web | -| nightly | Commits to the master branch of Calibre-Web | +| Tag | Available | Description | +| :----: | :----: |--- | +| latest | ✅ | Releases of Calibre-Web | +| nightly | ✅ | Commits to the master branch of Calibre-Web | ## Application Setup @@ -109,7 +109,7 @@ Here are some example snippets to help you get started creating a container. version: "2.1" services: calibre-web: - image: lscr.io/linuxserver/calibre-web + image: lscr.io/linuxserver/calibre-web:latest container_name: calibre-web environment: - PUID=1000 @@ -139,7 +139,7 @@ docker run -d \ -v /path/to/data:/config \ -v /path/to/calibre/library:/books \ --restart unless-stopped \ - lscr.io/linuxserver/calibre-web + lscr.io/linuxserver/calibre-web:latest ``` ## Parameters @@ -200,7 +200,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to * container version number * `docker inspect -f '{{ index .Config.Labels "build_version" }}' calibre-web` * image version number - * `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/calibre-web` + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/calibre-web:latest` ## Updating Info @@ -218,7 +218,7 @@ Below are the instructions for updating containers: ### Via Docker Run -* Update the image: `docker pull lscr.io/linuxserver/calibre-web` +* Update the image: `docker pull lscr.io/linuxserver/calibre-web:latest` * Stop the running container: `docker stop calibre-web` * Delete the container: `docker rm calibre-web` * Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)