doc: rewrite readme

This commit is contained in:
mappu 2018-06-09 17:41:21 +12:00
parent ae7119f65a
commit 2dcf1dbc15

View File

@ -2,19 +2,27 @@ A thumbnailing library for Go.
Written in Go
Earlier versions of this project were vendored into `webdir`.
- Supports jpeg / png / gif files (internally) and video files (requires `ffmpeg` in `$PATH`)
- LRU cache of recent thumbnails for performance
- Scaling algorithms: Nearest-neighbour or bilinear
- Aspect ratio preserving (fit outside with image crop; fit inside with transparent background; fit inside with dimension reduction)
- Output formats: JPG (internal) or transparent PNG (via `go-imagequant`)
- Supports jpeg / png / gif / bmp / webp files (internally)
- Supports video files (requires `ffmpeg` in `$PATH`)
- Optional LRU cache of recent thumbnails for performance
- Sampling algorithms: Nearest-neighbour, Bilinear (fast), Bilinear (accurate), Bicubic (Catmull-Rom)
- Scaling algorithms: Fit inside, Fit outside, Stretch
- Output formats: JPG, PNG, Quantised/lossy PNG (via `go-imagequant`), BMP
A standalone binary `mkthumb` is provided as a sample utility.
=CHANGELOG=
2018-05-04 0.2.1
2018-06-09 1.0.0
- Feature: Major speed improvement
- Feature: Support FitInside, FitOutside, and Stretch stretching modes
- Feature: Support Bilnear (Fast), Bilnear (Accurate), and Bicubic (Catmull-Rom) scaling algorithms
- Feature: Support PNG output without imagequant; support BMP output
- Feature: Support Webp and BMP input files
- Fix wrong dimension output for video input files
- Fix jagged output of bilinear resizer
2018-06-04 0.2.1
- Add `disableimagecrush` build tag option to exclude cgo library dependency
2017-11-18 0.2.0
@ -24,4 +32,3 @@ A standalone binary `mkthumb` is provided as a sample utility.
2017-01-03 0.1.0
- Version of `thumbnail` vendored with `webdir` 1.0 (previously tagged as `release-1.0`)