]> git.ipfire.org Git - thirdparty/zstd.git/commitdiff
adding more to readme
authorPaul Cruz <paulcruz74@fb.com>
Tue, 25 Jul 2017 23:55:16 +0000 (16:55 -0700)
committerPaul Cruz <paulcruz74@fb.com>
Tue, 25 Jul 2017 23:55:16 +0000 (16:55 -0700)
contrib/adaptive-compression/README.md

index 1d261337788d16ae3de47f4294cff6333d7a4cd5..09923d1909280227eabd90a2386f46fad6ea0b9a 100644 (file)
@@ -1,2 +1,8 @@
-ZSTD_adapt is a compression tool targeted at optimizing performance across network connections. The tool aims at sensing network speeds and adapting compression level based on network or pipe speeds.
-In many scenarios, using ZSTD without a properly adjusted compression level results in a pipe bottleneck, or a compressed file that could have been reduced in size.
+###Summary
+
+`adapt` is a new compression tool targeted at optimizing performance across network connections. The tool aims at sensing network speeds and adapting compression level based on network or pipe speeds.
+In situations where the compression level does not appropriately match the network/pipe speed, the compression may be bottlenecking the entire pipeline or the files may not be compressed as much as they potentially could be, therefore losing efficiency. It also becomes quite impractical to manually measure and set compression level, therefore the tool does it for you.
+
+###Using `adapt`
+
+In order to build and use the tool, you can simply run `make adapt` in the `adaptive-compression` directory under `contrib`. This will generate an executable available for use.