Skip to content

Commit c0aab5e

Browse files
committed
Update opam file with more metadata
Signed-off-by: Rudi Grinberg <[email protected]>
1 parent bd5020b commit c0aab5e

File tree

2 files changed

+41
-0
lines changed

2 files changed

+41
-0
lines changed

biniou.opam

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,29 @@ build: [
88
]
99
maintainer: ["[email protected]"]
1010
authors: ["Martin Jambon"]
11+
bug-reports: "https://github.com/mjambon/biniou/issues"
12+
homepage: "https://github.com/mjambon/biniou"
13+
doc: "https://mjambon.github.io/biniou/"
1114
license: "BSD-3-Clause"
15+
dev-repo: "git+https://github.com/mjambon/biniou.git"
16+
synopsis:
17+
"Binary data format designed for speed, safety, ease of use and backward compatibility as protocols evolve"
18+
description: """
19+
20+
Biniou (pronounced "be new") is a binary data format designed for speed, safety,
21+
ease of use and backward compatibility as protocols evolve. Biniou is vastly
22+
equivalent to JSON in terms of functionality but allows implementations several
23+
times faster (4 times faster than yojson), with 25-35% space savings.
24+
25+
Biniou data can be decoded into human-readable form without knowledge of type
26+
definitions except for field and variant names which are represented by 31-bit
27+
hashes. A program named bdump is provided for routine visualization of biniou
28+
data files.
29+
30+
The program atdgen is used to derive OCaml-Biniou serializers and deserializers
31+
from type definitions.
32+
33+
Biniou format specification: mjambon.github.io/atdgen-doc/biniou-format.txt"""
1234
depends: [
1335
"easy-format"
1436
"dune" {>= "1.10"}

dune-project

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,28 @@
66
(maintainers "[email protected]")
77
(authors "Martin Jambon")
88
(implicit_transitive_deps false)
9+
(source (github mjambon/biniou))
10+
(documentation "https://mjambon.github.io/biniou/")
911

1012
(package
1113
(name biniou)
14+
(synopsis
15+
"Binary data format designed for speed, safety, ease of use and backward compatibility as protocols evolve")
16+
(description "
17+
Biniou (pronounced \"be new\") is a binary data format designed for speed, safety,
18+
ease of use and backward compatibility as protocols evolve. Biniou is vastly
19+
equivalent to JSON in terms of functionality but allows implementations several
20+
times faster (4 times faster than yojson), with 25-35% space savings.
21+
22+
Biniou data can be decoded into human-readable form without knowledge of type
23+
definitions except for field and variant names which are represented by 31-bit
24+
hashes. A program named bdump is provided for routine visualization of biniou
25+
data files.
26+
27+
The program atdgen is used to derive OCaml-Biniou serializers and deserializers
28+
from type definitions.
29+
30+
Biniou format specification: mjambon.github.io/atdgen-doc/biniou-format.txt")
1231
(depends
1332
easy-format
1433
(dune (>= 1.10))

0 commit comments

Comments
 (0)