mirror of
https://github.com/gorhill/uBlock.git
synced 2024-09-18 08:52:26 +02:00
explain purpose of files (for reviewers really)
This commit is contained in:
parent
55501c4cdf
commit
815283c77c
41
src/lib/lz4/README.md
Normal file
41
src/lib/lz4/README.md
Normal file
@ -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`.
|
Loading…
Reference in New Issue
Block a user