Skip to content

Commit ba1e357

Browse files
committed
More docs tweaks
1 parent d4bbc12 commit ba1e357

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,13 @@ Hitchhiker trees are a newly invented datastructure, synthesizing fractal trees
55
## What's in this Repository?
66

77
The hitchhiker namespaces contain a complete implementation of a persistent, serializable, lazily-loaded hitchhiker tree.
8-
This is a sorted key-value datastructure, like a scalable, pluggable, incrementally serializable `sorted-map`.
8+
This is a sorted key-value datastructure, like a scalable `sorted-map`.
9+
It can incrementally persist and automatically lazily load itself from any backing storewhich implements a simple protocol.
910

1011
Outboard is a sample application for the hitchhiker tree.
1112
It includes an implementation of the IO subsystem backed by Redis, and it manages all of the incremental serialization and flushing.
1213

13-
The hitchhiker tree is designed very similarly to how Datomic's backing trees must work--I would love to see integration with [DataScript](https://github.com/tonsky/datascript).
14+
The hitchhiker tree is designed very similarly to how Datomic's backing trees must work--I would love to see integration with [DataScript](https://github.com/tonsky/datascript) for a fully open source [Datomic](http://www.datomic.com).
1415

1516
## Outboard
1617

doc/hitchhiker.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,8 @@ In `hitchhiker.tree.core`, we have several important protocols:
104104
`anchor-root` is called by the persistence functionality to ensure that the backend knows which nodes are roots; this is a hint to any sorts of garbage collectors.
105105
+
106106
`delete-addr` removes the given node from storage.
107+
+
108+
`TestingBackend` is a simple implementation of a backend which bypasses serialization and is entirely in memory. It can be a useful reference for the bare minimum implementation of a backend.
107109

108110
`hitchhiker.tree.messaging/IOperation`::
109111
This protocol describes an operation to the tree.

0 commit comments

Comments
 (0)