Skip to content

Commit

Permalink
docs: refine documentation and Docker usage
Browse files Browse the repository at this point in the history
- 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 <[email protected]>
  • Loading branch information
appleboy committed Feb 3, 2024
1 parent 6271b5e commit 4b7f337
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit 4b7f337

Please sign in to comment.