path: root/docs/common/lib_compress.txt
diff options
Diffstat (limited to 'docs/common/lib_compress.txt')
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/common/lib_compress.txt b/docs/common/lib_compress.txt
new file mode 100644
index 00000000..f3e26f20
--- /dev/null
+++ b/docs/common/lib_compress.txt
@@ -0,0 +1,8 @@
+TITLE lib/compress
+This is a horrid C++ interface to zlib. It is written this way to avoid having to buffer any data, and so be unnecessarily inefficient. But this does end up just being a wrapper to the zlib interface.
+See test/compress for an example of how to use it. But it should be very familiar.
+For an easier interface, use CompressStream.