Update SYNOPSIS.

README.rst

@@ -24,17 +24,44 @@ SYNOPSIS
 
   import brotli;
 
-  # Encoder and decoder objects
-  new <obj> = brotli.encoder(...)
-  # VOID <obj>.create_stats()
-  new <obj> = brotli.decoder(...)
-  # VOID <obj>.create_stats()
-
-  # XXX ...
+  # The built-in "unbr" filter decompresses brotli-encoded backend
+  # responses with default parameters.
+  sub vcl_backend_response {
+  	if (beresp.http.Content-Encoding == "br") {
+		set beresp.filters = "unbr";
+	}
+  }
+
+  # The built-in "br" filter compresses backend responses with default
+  # parameters.
+  sub vcl_backend_response {
+  	if (bereq.http.Accept-Encoding ~ "\bbr\b") {
+		set beresp.filters = "br";
+	}
+  }
+
+  # Create statistics for the built-in filters.
+  VOID brotli.create_br_stats()
+  VOID brotli.create_unbr_stats()
+
+  # Create a brotli compression filter with custom parameters.
+  new <obj> = brotli.encoder(STRING name, BYTES buffer, INT quality,
+                             INT lgwin)
+  VOID <obj>.create_stats()
+
+  # Create a brotli decompression filter with custom parameters.
+  new <obj> = brotli.decoder(STRING name, BYTES buffer, BOOL lgwin)
+  VOID <obj>.create_stats()
 
   # VFP version
   STRING brotli.version()
 
+  # encoder library version
+  STRING brotli.encoder_version()
+
+  # decoder library version
+  STRING brotli.decoder_version()
+
 DESCRIPTION
 ===========
 
@@ -43,7 +70,11 @@ algorithm for responses fetched from backends.
 
 XXX ...
 
-# $Object encoder(BOOL case_sensitive=1)
+# $Object encoder(STRING name, BYTES buffer=32k, INT quality=11, INT lgwin=22)
+
+XXX ...
+
+# $Object decoder(STRING name, BYTES buffer=32k, BOOL lgwin=0)
 
 XXX ...
 

src/vfp_brotli.vcc

@@ -20,17 +20,44 @@ SYNOPSIS
 
   import brotli;
 
-  # Encoder and decoder objects
-  new <obj> = brotli.encoder(...)
-  # VOID <obj>.create_stats()
-  new <obj> = brotli.decoder(...)
-  # VOID <obj>.create_stats()
-
-  # XXX ...
+  # The built-in "unbr" filter decompresses brotli-encoded backend
+  # responses with default parameters.
+  sub vcl_backend_response {
+  	if (beresp.http.Content-Encoding == "br") {
+		set beresp.filters = "unbr";
+	}
+  }
+
+  # The built-in "br" filter compresses backend responses with default
+  # parameters.
+  sub vcl_backend_response {
+  	if (bereq.http.Accept-Encoding ~ "\bbr\b") {
+		set beresp.filters = "br";
+	}
+  }
+
+  # Create statistics for the built-in filters.
+  VOID brotli.create_br_stats()
+  VOID brotli.create_unbr_stats()
+
+  # Create a brotli compression filter with custom parameters.
+  new <obj> = brotli.encoder(STRING name, BYTES buffer, INT quality,
+                             INT lgwin)
+  VOID <obj>.create_stats()
+
+  # Create a brotli decompression filter with custom parameters.
+  new <obj> = brotli.decoder(STRING name, BYTES buffer, BOOL lgwin)
+  VOID <obj>.create_stats()
 
   # VFP version
   STRING brotli.version()
 
+  # encoder library version
+  STRING brotli.encoder_version()
+
+  # decoder library version
+  STRING brotli.decoder_version()
+
 DESCRIPTION
 ===========
 
@@ -39,7 +66,11 @@ algorithm for responses fetched from backends.
 
 XXX ...
 
-# $Object encoder(BOOL case_sensitive=1)
+# $Object encoder(STRING name, BYTES buffer=32k, INT quality=11, INT lgwin=22)
+
+XXX ...
+
+# $Object decoder(STRING name, BYTES buffer=32k, BOOL lgwin=0)
 
 XXX ...