diff --git a/README.md b/README.md index 7e6b54a..b1dd51c 100644 --- a/README.md +++ b/README.md @@ -31,16 +31,17 @@ It's basically between `ExpressJS` and `Fiber`, much faster than the `http` pack ## Usage -Regarding the `IMG_PATH` section in `config.json`, if you are serving images at `https://example.com/pics/tsuki.jpg` and your files are at `/var/www/image/pics/tsuki.jpg`, then `IMG_PATH` shall be `/var/www/image`. +Regarding the `IMG_PATH` section in `config.json`. +If you are serving images at `https://example.com/pics/tsuki.jpg` and +your files are at `/var/www/image/pics/tsuki.jpg`, then `IMG_PATH` shall be `/var/www/image`. 1. Edit the `config.json` to face your need, default convert quality is 80%. 2. Run the binary like this: `./webp_server`, use `screen` or `tmux` to hold it currently. 3. Let Nginx to `proxy_pass http://localhost:3333/;` ## TODO - -- [] This version doesn't support header-based-output, which means Safari users will not see the converted `webp` images, this should be fixed in later releases. -- [] Multi platform support. +- [ ] This version doesn't support header-based-output, which means Safari users will not see the converted `webp` images, this should be fixed in later releases. +- [ ] Multi platform support. ## build your own binary Install golang, enable go module, and then... @@ -48,4 +49,5 @@ Install golang, enable go module, and then... go get github.com/gofiber/fiber go get github.com/chai2010/webp go build webp_server.go -``` \ No newline at end of file +``` +**Due to the limitations of webp module, you can't cross compile this tool.** \ No newline at end of file