Skip to content

Commit 0b45416

Browse files
committed
doc: added the $zstd_ratio descriptions
1 parent 9574c85 commit 0b45416

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ zstd-nginx-module - Nginx module for the [Zstandard compression](https://faceboo
1414
* [zstd_min_length](#zstd_min_length)
1515
* [zstd_types](#zstd_types)
1616
* [zstd_buffers](#zstd_buffers)
17+
* [Variables](#variables)
18+
* [$zstd_ratio](#$zstd_ratio)
1719
* [Author](#author)
1820

1921
# Status
@@ -44,7 +46,7 @@ server {
4446

4547
# Installation
4648

47-
To use this module, configure your nginx branch with `--add-module=/path/to/zstd-nginx-module`. several points should be taken care.
49+
To use this module, configure your nginx branch with `--add-module=/path/to/zstd-nginx-module`. Several points should be taken care.
4850

4951
* You can set environment variables `ZSTD_INC` and `ZSTD_LIB` to specify the path to `zstd.h` and the path to zstd shared library represently.
5052
* static library will be tried prior to dynamic library, since this Nginx module uses some **advanced APIs** where static linking is recommended.
@@ -100,6 +102,12 @@ Enables ztd of responses for the specified MIME types in addition to "text/html"
100102

101103
Sets the number and size of buffers used to compress a response. By default, the buffer size is equal to one memory page. This is either 4K or 8K, depending on a platform.
102104

105+
# Variables
106+
107+
## $zstd_ratio
108+
109+
Achieved compression ratio, computed as the ratio between the original and compressed response sizes.
110+
103111
# Author
104112

105113
Alex Zhang (张超) zchao1995@gmail, UPYUN Inc.

0 commit comments

Comments
 (0)