From 5d3ebe684b0940c06b70e1cc24592a40d90737de Mon Sep 17 00:00:00 2001 From: Adrian Shum Date: Mon, 3 Oct 2022 13:31:16 +0800 Subject: [PATCH] docs: update description --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8c9253d..3971973 100644 --- a/README.md +++ b/README.md @@ -5,16 +5,14 @@ [![Docker Hub](https://img.shields.io/badge/docker-shumc/imagorvideo-blue.svg)](https://hub.docker.com/r/shumc/imagorvideo/) [![GitHub Container Registry](https://ghcr-badge.herokuapp.com/cshum/imagorvideo/latest_tag?trim=major&label=ghcr.io&ignore=next,master&color=%23007ec6)](https://github.com/cshum/imagorvideo/pkgs/container/imagorvideo) - imagorvideo is a new initiative that brings video thumbnail capability through ffmpeg, built on the foundations of [imagor](https://github.com/cshum/imagor) - a fast, Docker-ready image processing server written in Go with libvips. -Imagorvideo uses ffmpeg C bindings that extracts image thumbnail from video by attempting to select the best frame, then forwards to libvips to perform all existing image operations supported by imagor. +imagorvideo uses ffmpeg C bindings that extracts image thumbnail from video by attempting to select the best frame, then forwards to libvips to perform all the image cropping, resizing and filters supported by imagor. -imagorvideo uses reader stream for mkv and webm video types. For other video types that requires seeking from a non seek-able source such as HTTP or S3, it simulates seek using memory buffer or temp file, by having the whole file to be fully loaded to perform seek. +imagorvideo uses read stream for mkv and webm video types. For other video types that requires seeking from a non seek-able source such as HTTP or S3, it simulates seek using memory buffer or temp file, by having the whole file to be fully loaded to perform seek. This also aims to be a reference project demonstrating imagor extension. - ### Quick Start ```bash @@ -32,7 +30,7 @@ http://localhost:8000/unsafe/fit-in/300x200/filters:label(imagorvideo,10,-10,20, ``` -Check out [imagor](https://github.com/cshum/imagor#image-endpoint) for all existing image operations supported. +Check out [imagor](https://github.com/cshum/imagor#image-endpoint) for all image features supported. ### Configuration