From 4b7f33771770e8f528c729cfe50cefc260421822 Mon Sep 17 00:00:00 2001 From: Bo-Yi Wu Date: Sat, 3 Feb 2024 11:05:59 +0800 Subject: [PATCH] docs: refine documentation and Docker usage - Update the project description in `README.md` to provide a more detailed explanation of Nginx Image Resizer's functionality. - Change Docker image tags in build and run instructions to use a fully qualified image name with the `ghcr.io` prefix. Signed-off-by: Bo-Yi Wu --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 32e3260..72adafe 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,12 @@ [![Docker Image](https://github.com/appleboy/nginx-image-resizer/actions/workflows/docker.yml/badge.svg?branch=master)](https://github.com/appleboy/nginx-image-resizer/actions/workflows/docker.yml) -Docker Container of real time image resizing and caching +Nginx Image Resizer is a Docker-based tool that uses Nginx and ImageMagick to dynamically resize images. When you run this Docker image, you can specify the size of the image through URL parameters, and Nginx Image Resizer will return the resized image. This tool is particularly useful for websites and applications that need to dynamically adjust image sizes. ## Build Image ```bash -docker build -t appleboy/nginx-image-resizer . +docker build -t ghcr.io/appleboy/nginx-image-resizer . ``` ## RUN Image @@ -19,7 +19,7 @@ docker run --restart always \ -p 8002:80 \ -e NGINX_HOST=localhost \ -e IMAGE_HOST="http://localhost:9000" \ - appleboy/nginx-image-resizer + ghcr.io/appleboy/nginx-image-resizer ``` ## Paramemter