Skip to content

Commit 4b4d543

Browse files
committed
Update ezgzip.opam to make dune-release happy
1 parent fe2293c commit 4b4d543

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

ezgzip.opam

+25
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,31 @@ maintainer: "Hezekiah M. Carty <[email protected]>"
33
authors: [ "Hezekiah M. Carty <[email protected]>" ]
44
license: "MIT"
55
synopsis: "Simple gzip (de)compression library"
6+
description: """
7+
# ezgzip - Simple gzip (de)compression library
8+
9+
ezgzip is a simple interface focused on `string -> string` zlib and gzip
10+
(de)compression.
11+
12+
Documentation is available
13+
[here](https://hcarty.github.io/ezgzip/ezgzip/index.html).
14+
15+
An example illustrating how to gzip compress and then decompress a string:
16+
```ocaml
17+
open Rresult
18+
19+
let () =
20+
let original = "Hello world" in
21+
let compressed = Ezgzip.compress original in
22+
let decompressed = R.get_ok (Ezgzip.decompress compressed) in
23+
assert (original = decompressed)
24+
```
25+
26+
This library currently uses the zlib bindings provided by
27+
[camlzip](https://github.com/xavierleroy/camlzip). The gzip header/footer code
28+
is based on the
29+
[upstream specification](http://www.gzip.org/zlib/rfc-gzip.html#specification).
30+
"""
631
homepage: "https://github.com/hcarty/ezgzip"
732
dev-repo: "git+https://github.com/hcarty/ezgzip.git"
833
bug-reports: "https://github.com/hcarty/ezgzip/issues"

0 commit comments

Comments
 (0)