We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 3684233 commit 3885042Copy full SHA for 3885042
README.md
@@ -1,8 +1,12 @@
1
# ezgzip - Simple gzip (de)compression library
2
3
+ezgzip is a simple interface focused on `string -> string` zlib and gzip
4
+(de)compression.
5
+
6
Documentation is available
7
[here](https://hcarty.github.io/ezgzip/ezgzip/index.html).
8
9
+An example illustrating how to gzip compress and then decompress a string:
10
```ocaml
11
open Rresult
12
@@ -13,6 +17,11 @@ let () =
13
17
assert (original = decompressed)
14
18
```
15
19
20
+This library currently uses the zlib bindings provided by
21
+[camlzip](https://github.com/xavierleroy/camlzip). The gzip header/footer code
22
+is based on the
23
+[upstream specification](http://www.gzip.org/zlib/rfc-gzip.html#specification).
24
16
25
## Compile
26
27
0 commit comments