From c4b44fb12108c0764d1fa4ef1c37f11a54379343 Mon Sep 17 00:00:00 2001
From: Piotr Szarmanski
Date: Mon, 24 Oct 2022 10:50:11 +0200
Subject: Add hash-backend and update README.

---
 README | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

(limited to 'README')

diff --git a/README b/README
index 21afb2f..606afba 100644
--- a/README
+++ b/README
@@ -41,3 +41,20 @@ function will attempt to decode an ERIS read-capability in parallel into a file
 specified by the OUTPUT-FILE string or pathspec.
 
 See the docstrings of the specific functions for more details.
+
+
+
+A high-level API is provided for convenience in backend.lisp. The concept is
+that a backend object is created, which holds information like output-function,
+fetch-function, caching details, block-size, etc. and the {en/de}coding
+functions simply take the backend as an argument.
+
+This interface consists of two generic functions: store-data, for encoding data,
+and fetch-read-capability, for retrieving the contents of a read-capability
+object.
+
+As an example, a file-based backend called file-backend is provided. It can be
+used simply by making an instance of the 'file-backend class with a :directory
+argument, which will point to the directory in which ERIS data is to be stored.
+
+There is also hash-backend, which implements a simple hash-table backend.
-- 
cgit v1.2.3