30 lines
938 B
Markdown
30 lines
938 B
Markdown
|
## mirage-kv — MirageOS signatures for key/value devices
|
||
|
|
|
||
|
|
mirage-kv provides the [Mirage_kv.RO][ro] and [Mirage_kv.RW][rw]
|
||
|
|
signatures the MirageOS key/value devices should implement.
|
||
|
|
|
||
|
|
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
|
||
|
|
|
||
|
|
[](https://travis-ci.org/mirage/mirage-kv)
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
mirage-kv can be installed with `opam`:
|
||
|
|
|
||
|
|
opam install mirage-kv
|
||
|
|
|
||
|
|
If you don't use `opam` consult the [`opam`](opam) file for build
|
||
|
|
instructions.
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
|
||
|
|
The documentation and API reference is generated from the source
|
||
|
|
interfaces. API docs for both [mirage-kv][doc-mirage-kv]
|
||
|
|
can be consulted online or via `odig
|
||
|
|
doc mirage-kv`.
|
||
|
|
|
||
|
|
[doc-mirage-kv]: http://docs.mirage.io/mirage-kv/
|