polish opam metadata

dune-project

@@ -1,26 +1,19 @@
-(lang dune 3.4)
-
-(name kittyimg)
-
+(lang dune 2.0)
 (generate_opam_files true)
 
-(source
- (github username/reponame))
-
-(authors "Author Name")
-
-(maintainers "Maintainer Name")
-
-(license LICENSE)
-
-(documentation https://url/to/documentation)
+(name kittyimg)
+(version 0.1)
+(source (github Armael/ocaml-kittyimg))
+(authors "Armaël Guéneau <[email protected]>")
+(maintainers "Armaël Guéneau <[email protected]>")
+(license MIT)
 
 (package
  (name kittyimg)
- (synopsis "A short synopsis")
- (description "A longer description")
- (depends ocaml dune)
- (tags
-  (topics "to describe" your project)))
-
-; See the complete stanza docs at https://dune.readthedocs.io/en/stable/dune-files.html#dune-project
+ (synopsis "An implementation of Kitty's terminal graphics protocol")
+ (description "Kitty's terminal graphics protocol allows displaying images in compatible terminal emulators")
+ (depends
+  (ocaml (>= 4.08))
+  (dune (>= 2.0))
+  (base64 (>= 3.0.0))
+ ))

kittyimg.opam

@@ -1,21 +1,21 @@
 # This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
-synopsis: "A short synopsis"
-description: "A longer description"
-maintainer: ["Maintainer Name"]
-authors: ["Author Name"]
-license: "LICENSE"
-tags: ["topics" "to describe" "your" "project"]
-homepage: "https://github.com/username/reponame"
-doc: "https://url/to/documentation"
-bug-reports: "https://github.com/username/reponame/issues"
+version: "0.1"
+synopsis: "An implementation of Kitty's terminal graphics protocol"
+description:
+  "Kitty's terminal graphics protocol allows displaying images in compatible terminal emulators"
+maintainer: ["Armaël Guéneau <[email protected]>"]
+authors: ["Armaël Guéneau <[email protected]>"]
+license: "MIT"
+homepage: "https://github.com/Armael/ocaml-kittyimg"
+bug-reports: "https://github.com/Armael/ocaml-kittyimg/issues"
 depends: [
-  "ocaml"
-  "dune" {>= "3.4"}
-  "odoc" {with-doc}
+  "ocaml" {>= "4.08"}
+  "dune" {>= "2.0"}
+  "base64" {>= "3.0.0"}
 ]
 build: [
-  ["dune" "subst"] {dev}
+  ["dune" "subst"] {pinned}
   [
     "dune"
     "build"
@@ -28,4 +28,4 @@ build: [
     "@doc" {with-doc}
   ]
 ]
-dev-repo: "git+https://github.com/username/reponame.git"
+dev-repo: "git+https://github.com/Armael/ocaml-kittyimg.git"

lib/kittyimg.mli

@@ -1,3 +1,8 @@
+(** An OCaml implementation for the client-side terminal graphics protocol of
+    the Kitty terminal emulator. See {{:
+    https://sw.kovidgoyal.net/kitty/graphics-protocol/} the protocol
+    specification} for more information. *)
+
 val string_of_bytes_ba :
   (int, Bigarray.int8_unsigned_elt, Bigarray.c_layout) Bigarray.Array1.t ->
   string