Skip to content

Commit 3885042

Browse files
committed
Update README
1 parent 3684233 commit 3885042

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
# ezgzip - Simple gzip (de)compression library
22

3+
ezgzip is a simple interface focused on `string -> string` zlib and gzip
4+
(de)compression.
5+
36
Documentation is available
47
[here](https://hcarty.github.io/ezgzip/ezgzip/index.html).
58

9+
An example illustrating how to gzip compress and then decompress a string:
610
```ocaml
711
open Rresult
812
@@ -13,6 +17,11 @@ let () =
1317
assert (original = decompressed)
1418
```
1519

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+
1625
## Compile
1726

1827
```

0 commit comments

Comments
 (0)