aboutsummaryrefslogtreecommitdiffstats
path: root/library/cpp/blockcodecs/README.md
diff options
context:
space:
mode:
authormvel <mvel@yandex-team.ru>2022-02-10 16:45:41 +0300
committerDaniil Cherednik <dcherednik@yandex-team.ru>2022-02-10 16:45:41 +0300
commitbd30392c4cc92487950adc375c07adf52da1d592 (patch)
treee8d1a3f19b7fc890bcef6e4cc5de41f1d88c9ac3 /library/cpp/blockcodecs/README.md
parent5d50718e66d9c037dc587a0211110b7d25a66185 (diff)
downloadydb-bd30392c4cc92487950adc375c07adf52da1d592.tar.gz
Restoring authorship annotation for <mvel@yandex-team.ru>. Commit 1 of 2.
Diffstat (limited to 'library/cpp/blockcodecs/README.md')
-rw-r--r--library/cpp/blockcodecs/README.md32
1 files changed, 16 insertions, 16 deletions
diff --git a/library/cpp/blockcodecs/README.md b/library/cpp/blockcodecs/README.md
index 417917a475..b8e9bf16dc 100644
--- a/library/cpp/blockcodecs/README.md
+++ b/library/cpp/blockcodecs/README.md
@@ -1,20 +1,20 @@
-This is a simple library for block data compression (this means data is compressed/uncompressed
+This is a simple library for block data compression (this means data is compressed/uncompressed
by whole blocks in memory). It's a lite-version of the `library/cpp/codecs`. Lite here means that it
-provide only well-known compression algorithms, without the possibility of learning.
-
-There are two possible ways to work with it.
-
-Codec by name
-=============
-Use `NBlockCodec::Codec` to obtain the codec by name. The codec can be asked to compress
-or decompress something and in various ways.
-
-To get a full list of codecs there is a function `NBlockCodecs::ListAllCodecs()`.
-
-Streaming
-=========
-Use `stream.h` to obtain simple streams over block codecs (buffer data, compress them by blocks,
-write to the resulting stream).
+provide only well-known compression algorithms, without the possibility of learning.
+
+There are two possible ways to work with it.
+
+Codec by name
+=============
+Use `NBlockCodec::Codec` to obtain the codec by name. The codec can be asked to compress
+or decompress something and in various ways.
+
+To get a full list of codecs there is a function `NBlockCodecs::ListAllCodecs()`.
+
+Streaming
+=========
+Use `stream.h` to obtain simple streams over block codecs (buffer data, compress them by blocks,
+write to the resulting stream).
Using codec plugins
===================