diff --git a/CHANGES.md b/CHANGES.md index 70f66c7..0eab525 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,3 +1,17 @@ +### v2.0.0 (2019-02-24) + +* Major revision of the `RO` signature: + - values are of type `string` + - keys are segments instead of a string + - `read` is now named `get`, and does no longer take an offset and length + - the new function `list` is provided + - the new functions `last_modified` and `digest` are provided +* A module `Key` is provided with convenience functions to build keys +* An `RW` signature is provided, extending `RO` with + - a function `set` to replace a value + - a function `remove` to remove a key + - `batch` to batch operations + ### v1.1.1 (2017-06-29) * Remove `open Result` statements (and drop support to 4.02) diff --git a/README.md b/README.md index c1aefdd..d1e0516 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,16 @@ ## mirage-kv — MirageOS signatures for key/value devices -mirage-kv provides the [Mirage_kv.RO][ro] and [Mirage_kv_lwt.RO][ro-lwt] -signatures the MirageOS key/value devices should implement. +mirage-kv provides the [Mirage_kv.RO][ro] and [Mirage_kv.RW][rw] +signatures the MirageOS key/value devices should implement. In addition, +[Mirage_kv_lwt.RO][ro-lwt] and [Mirage_kv_lwt.RW][rw-lwt] are provided where +`io` is constrained to `Lwt.t` and `value` to `string`. mirage-kv is distributed under the ISC license. [ro]: https://mirage.github.io/mirage-kv/mirage-kv/Mirage_kv/module-type-RO/index.html +[rw]: https://mirage.github.io/mirage-kv/mirage-kv/Mirage_kv/module-type-RW/index.html [ro-lwt]: https://mirage.github.io/mirage-kv/mirage-kv-lwt/Mirage_kv_lwt/index.html#module-type-RO +[rw-lwt]: https://mirage.github.io/mirage-kv/mirage-kv-lwt/Mirage_kv_lwt/index.html#module-type-RW [![Build Status](https://travis-ci.org/mirage/mirage-kv.svg?branch=master)](https://travis-ci.org/mirage/mirage-kv) diff --git a/mirage-kv-lwt.opam b/mirage-kv-lwt.opam index ea15420..0b2e8b6 100644 --- a/mirage-kv-lwt.opam +++ b/mirage-kv-lwt.opam @@ -1,6 +1,6 @@ opam-version: "2.0" maintainer: "Thomas Gazagnaire " -authors: ["Thomas Gazagnaire "] +authors: ["Thomas Gazagnaire " "Stefanie Schirmer" "Hannes Mehnert"] homepage: "https://github.com/mirage/mirage-kv" doc: "https://mirage.github.io/mirage-kv/" license: "ISC" @@ -14,7 +14,7 @@ build: [ ] depends: [ - "ocaml" {>= "4.03.0"} + "ocaml" {>= "4.05.0"} "dune" {build} "mirage-kv" {>= "1.0.0"} "lwt" @@ -22,3 +22,8 @@ depends: [ ] synopsis: "MirageOS signatures for key/value devices" +description: """ +mirage-kv-lwt provides the `Mirage_kv_lwt.RO` and `Mirage_kv_lwt.RW` signatures, +which are the corresponding `Mirage_kv` signatures with `io` constrained to +`Lwt.t` and `value` to `string`. +""" diff --git a/mirage-kv.opam b/mirage-kv.opam index f851b3f..7ea8052 100644 --- a/mirage-kv.opam +++ b/mirage-kv.opam @@ -1,6 +1,6 @@ opam-version: "2.0" maintainer: "Thomas Gazagnaire " -authors: ["Thomas Gazagnaire "] +authors: ["Thomas Gazagnaire " "Stefanie Schirmer" "Hannes Mehnert"] homepage: "https://github.com/mirage/mirage-kv" doc: "https://mirage.github.io/mirage-kv/" license: "ISC" @@ -11,15 +11,17 @@ tags: ["org:mirage"] build: [ ["dune" "subst"] {pinned} ["dune" "build" "-p" name "-j" jobs] -] -build-test: [ - ["dune" "runtest" "-p" name] + ["dune" "runtest" "-p" name] {with-test} ] depends: [ "ocaml" {>= "4.05.0"} "dune" {build} "mirage-device" {>= "1.0.0"} "fmt" - "alcotest" {test} + "alcotest" {with-test} ] synopsis: "MirageOS signatures for key/value devices" +description: """ +mirage-kv provides the `Mirage_kv.RO` and `Mirage_kv.RW` +signatures the MirageOS key/value devices should implement. +"""