summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorYann Collet <cyan@fb.com>2019-04-11 22:19:48 (GMT)
committerYann Collet <cyan@fb.com>2019-04-11 22:20:46 (GMT)
commitbcb26565a732062759a2428e167e27ad3c2f6e96 (patch)
tree7b192662cba336b688b23ea04fcd6f48cbb3fc48 /README.md
parent8d76c8a44a15cc7c0c1f345ba750e44edac7abb7 (diff)
downloadlz4-bcb26565a732062759a2428e167e27ad3c2f6e96.zip
lz4-bcb26565a732062759a2428e167e27ad3c2f6e96.tar.gz
lz4-bcb26565a732062759a2428e167e27ad3c2f6e96.tar.bz2
improved documentation for LZ4 dictionary compression
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 5 insertions, 3 deletions
diff --git a/README.md b/README.md
index e64020d..4e139e3 100644
--- a/README.md
+++ b/README.md
@@ -15,9 +15,11 @@ trading CPU time for improved compression ratio.
All versions feature the same decompression speed.
LZ4 is also compatible with [dictionary compression](https://github.com/facebook/zstd#the-case-for-small-data-compression),
-and can ingest any input file as dictionary,
-including those created by [Zstandard Dictionary Builder](https://github.com/facebook/zstd/blob/v1.3.5/programs/zstd.1.md#dictionary-builder).
-(note: only the final 64KB are used).
+both at [API](https://github.com/lz4/lz4/blob/v1.8.3/lib/lz4frame.h#L481) and [CLI](https://github.com/lz4/lz4/blob/v1.8.3/programs/lz4.1.md#operation-modifiers) levels.
+It can ingest any input file as dictionary, though only the final 64KB are used.
+This capability can be combined with the [Zstandard Dictionary Builder](https://github.com/facebook/zstd/blob/v1.3.5/programs/zstd.1.md#dictionary-builder),
+in order to drastically improve compression performance on small files.
+
LZ4 library is provided as open-source software using BSD 2-Clause license.