diff --git a/README.md b/README.md index e69de29..9dcf037 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,33 @@ +

+ ODIT Logo +

+ + +

NGINX - Brotli

+ + +## Description + +A custom alpine based nginx image including Brotli for compression. + +## Build + +```bash +docker build . +``` + +## Use +* Docker Image: registry.odit.services/library/nginx-brotli +* Webserver Folder Mount: /usr/share/nginx/html/ +* Nginx Config Mount: /etc/nginx/nginx.conf + +## Release a new version (triggers ci) +```bash +# pnpm +pnpm i +pnpm release + +# yarn +yarn +yarn release +``` \ No newline at end of file