From 1cc3d6ad62e2cde54618be9f6befbc79e393a6ff Mon Sep 17 00:00:00 2001
From: Piotr Szarmanski
Date: Thu, 3 Aug 2023 09:14:38 +0200
Subject: Update the readme & update version to 0.2.

---
 README | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

(limited to 'README')

diff --git a/README b/README
index 1e7bc5c..6957b09 100644
--- a/README
+++ b/README
@@ -22,6 +22,7 @@ read-capability-to-octets
 reference-to-block-urn
 block-urn-to-reference
 
+
 The eris-encode (INPUT BLOCK-SIZE OUTPUT-FUNCTION &KEY SECRET HASH-OUTPUT)
 function can be used to encode a vector or a stream into an ERIS
 read-capability.
@@ -53,4 +54,22 @@ 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.
+There is also hash-backend, which implements a simple hash-table backend. It is
+primarily meant for testing, not actual usage.
+
+The API contains the following symbols:
+
+fetch-data (READ-CAPABILITY BACKEND &key)
+store-data (INPUT BACKEND &key)
+
+Classes:
+
+encoding-backend
+decoding-backend
+
+An instance of file-backend can be instanced using (make-instance 'file-backend
+:directory "my/dir/with/eris/chunks/").
+
+For further information, see the docstrings.
+
+
-- 
cgit v1.2.3