From 815283c77c062acca326c4936c5b3cbd8631211c Mon Sep 17 00:00:00 2001
From: Raymond Hill <rhill@raymondhill.net>
Date: Sun, 12 Aug 2018 09:06:25 -0400
Subject: [PATCH] explain purpose of files (for reviewers really)

---
 src/lib/lz4/README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 src/lib/lz4/README.md

diff --git a/src/lib/lz4/README.md b/src/lib/lz4/README.md
new file mode 100644
index 000000000..2c62105bf
--- /dev/null
+++ b/src/lib/lz4/README.md
@@ -0,0 +1,41 @@
+## Purpose
+
+The purpose of this library is to implement LZ4 compression/decompression,
+as documented at the official LZ4 repository:
+
+https://github.com/lz4/lz4/blob/dev/doc/lz4_Block_format.md
+
+The files in this directory are developed as a separate project at:
+
+https://github.com/gorhill/lz4-wasm
+
+## Files
+
+### `lz4-block-codec-any.js`
+
+The purpose is to instanciate a WebAssembly- or pure javascript-based
+LZ4 block codec.
+
+If the choosen implementation is not specified, there will be an attempt to
+create a WebAssembly-based instance. If whatever reason this fails, a
+pure javascript-based instanced will be created.
+
+The script for either instances are dynamically loaded, such that no resources
+is wasted by keeping in memory code which won't be used.
+
+### `lz4-block-codec-wasm.js`
+
+This contains the code to instanciate WebAssembly-based LZ4 block codec. Note
+that the WebAssembly module is loaded using a `same-origin` fetch, hence
+ensuring that no code outside the package is loaded.
+
+### `lz4-block-codec-wasm.js`
+
+This contains the code to instanciate pure javascript-based LZ4 block codec.
+
+This is used as a fallback implementation should WebAssembly not be available
+for whatever reason.
+
+### `lz4-block-codec.wasm`
+
+This is the WebAssembly module, loaded by `lz4-block-codec-wasm.js`.