docs: flesh out README

2026-08-25 19:25:52 +00:00 · 2026-05-11 20:15:37 +07:00
parent d323fedd12
commit e14e44f0cf
1 changed files with 28 additions and 2 deletions
@@ -1,2 +1,28 @@
-# webp-worker
-Convert webp to other formats
+# webp-converter
+
+CLI tool written in Go to convert WebP images to other formats (PNG, JPG, etc.).
+
+## Quick start
+
+```bash
+go install github.com/tiennm99/webp-converter@latest
+webp-converter -input image.webp -output image.png
+```
+
+Or build from source:
+
+```bash
+go build -o webp-converter .
+./webp-converter -input image.webp -output image.png
+```
+
+Docker:
+
+```bash
+docker build -t webp-converter .
+docker run --rm -v $(pwd):/data webp-converter -input /data/image.webp -output /data/image.png
+```
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE).