-
Notifications
You must be signed in to change notification settings - Fork 157
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Expanded Irmin def. & minor line editing
- Loading branch information
1 parent
649657d
commit 20f1f95
Showing
1 changed file
with
11 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,32 +1,32 @@ | ||
{0 Irmin} | ||
|
||
[Irmin] is a distributed database built on the same principles as {{:https://git-scm.com} Git}. It can be used as an OCaml library that provides persistent stores with built-in snapshot, branching and reverting mechanisms. | ||
[Irmin] is a distributed database built on the same principles as {{:https://git-scm.com} Git}. Specifically designed for [the MiragoOS ecosystem](https://mirage.io/), it can be used as an OCaml library that provides persistent stores with built-in snapshot, branching, merging, history trackig, and reverting mechanisms, similar to a version control system like Git, but for data rather than code. | ||
|
||
{e Release %%VERSION%% - %%HOMEPAGE%%} | ||
|
||
{1 Irmin API} | ||
|
||
The [irmin] package defines the public API of [Irmin]. The entry point of the library is the module {!Irmin}. | ||
The [irmin] package defines the public API of [Irmin]. The module {!Irmin} is this library's entry point. | ||
|
||
{1 Backends} | ||
|
||
Irmin is designed to use a large variety of backends. Various backends are provided: | ||
Irmin is designed to use a large variety of backends: | ||
|
||
- {!module:Irmin_mem}: An in-memory store provided in the [irmin] package (this package). | ||
- {!Irmin_git}: A backend that exposes a bi-directional bridge to a Git repository proivded by the [irmin-git] package. | ||
- {!Irmin_pack}: A space-optimiezed, on-disk store inspired by {{:https://git-scm.com/book/en/v2/Git-Internals-Packfiles} Git Packfiles} is provided in the [irmin-pack] package. | ||
- {!Irmin_mirage}: A {{:https://mirage.io/} MirageOS} compatible store is provided in the [irmin-mirage] package. | ||
- {!Irmin_git}: A backend that exposes a bidirectional bridge to a Git repository, provided by the [irmin-git] package. | ||
- {!Irmin_pack}: A space-optimised, on-disk store inspired by {{:https://git-scm.com/book/en/v2/Git-Internals-Packfiles} Git Packfiles}, provided in the [irmin-pack] package. | ||
- {!Irmin_mirage}: A {{:https://mirage.io/} MirageOS} compatible store, provided in the [irmin-mirage] package. | ||
|
||
{1 Helpers and Internal Utilities} | ||
|
||
{2 irmin.unix} | ||
{2 [irmin.unix]} | ||
|
||
The [irmin.unix] package provides [Irmin] related utilities for Unix applications. | ||
|
||
The entry point of this library is the module {!Irmin_unix}. | ||
The module {!Irmin_unix} is this library's entry point. | ||
|
||
{2 irmin.data} | ||
{2 [irmin.data]} | ||
|
||
This package contains data structure implementations used in the implementation of Irmin. It is exposed only for internal use, and does not provide a stable API. | ||
This package contains data structure implementations used in the implementation of Irmin. It is exposed only for internal use and does not provide a stable API. | ||
|
||
The entry point of this library is the module {!Irmin_data}. | ||
The module {!Irmin_data} is this library's entry point. |