summaryrefslogtreecommitdiffstats
path: root/registry/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'registry/README.md')
-rw-r--r--registry/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/registry/README.md b/registry/README.md
new file mode 100644
index 000000000..617ef4a73
--- /dev/null
+++ b/registry/README.md
@@ -0,0 +1,15 @@
+# Registry Reading, etc
+
+This provides tools for dealing with the legacy binary types database
+format, still in use by extensions and the core code. While the actual
+binary file format is implemented by the `store` code, the wrapper
+that turns this into a type registry is implemented here.
+
+While this code is primarily used in only two modes:
+
+* linear write / concatenate
+* random access read
+
+The API unfortunately exposes a random-access write approach, which -
+while ~unused needs before we can re-write this away from the store
+backend.