diff --git a/README.md b/README.md index 8c6cb02..358354c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,33 @@ -# ffwebp +# FFWebP -*todo* +FFWebP is a command line utility for converting images between multiple formats. It automatically detects the input format and encodes the output using + +## Features + +- Pure Go implementation with no external runtime dependencies +- Supports BMP, GIF, JPEG, PNG, TIFF and WebP +- Lossy or lossless output with configurable quality +- Output codec selected from the output file extension when `--codec` is omitted +- Full set of format-specific flags for every supported format (see `ffwebp --help`) +- Additional formats may be added in the future + +## Building + +Compile with all codecs enabled using the `full` build tag: + +```bash +go build -tags full -o ffwebp ./cmd/ffwebp +``` + +You can enable a subset of codecs by selecting the appropriate build tags (for example `-tags "jpeg,png"`). + +## Usage + +```bash +ffwebp -i input.jpg -o output.webp +``` + +Run `ffwebp --help` to see the full list of flags. ## License