From fed34b8df2b19ba996ef810f44d5666437c90fb7 Mon Sep 17 00:00:00 2001
From: Piotr Szarmanski
Date: Fri, 25 Aug 2023 19:09:50 +0200
Subject: Add the parallel encoder.

---
 README | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

(limited to 'README')

diff --git a/README b/README
index 53d4c6d..e3262f5 100644
--- a/README
+++ b/README
@@ -32,7 +32,16 @@ function can be used to decode an ERIS read-capability. It returns a stream of
 the class ERIS-DECODE-STREAM: this class implements the Gray streams protocol.
 
 See the docstrings of the specific functions for more details. However, you
-should only use these to write custom backends; otherwise, see below..
+should only use these to write custom backends; otherwise, see below.
+
+NOTES ON ERIS-DECODE-STREAM:
+
+The implementation of all the methods behaves similarly to regular ones, except
+for FILE-POSITION with two arguments. On SBCL and a few other CL
+implementations, the implementation of the ordinary FILE-POSITION never fails.
+However, per the spec, it could fail in some cases. As such, the (SETF
+STREAM-FILE-POSITION) method on ERIS-DECODE-STREAM does fail if the index is
+larger or equal to EOF.
 
 
 
@@ -64,6 +73,11 @@ decoding-backend
 An instance of file-backend can be instanced using (make-instance 'file-backend
 :directory "my/dir/with/eris/chunks/").
 
+There are also parallel equivalents, p/fetch-data and p/store-data. These can be
+used on backends marked with p/encoding-backend; for example the file-backend.
+In practice, any backend that allows concurrent writes should has
+p/encoding-backend as a superclass.
+
 For further information, see the docstrings.
 
 
-- 
cgit v1.2.3