File tree 1 file changed +25
-0
lines changed
1 file changed +25
-0
lines changed Original file line number Diff line number Diff line change 3
3
authors: [ "Hezekiah M. Carty <
[email protected] >" ]
4
4
license: "MIT"
5
5
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
+ """
6
31
homepage: "https://github.com/hcarty/ezgzip"
7
32
dev-repo: "git+https://github.com/hcarty/ezgzip.git"
8
33
bug-reports: "https://github.com/hcarty/ezgzip/issues"
You can’t perform that action at this time.
0 commit comments