Skip to content

Add notice to S2 about MinLZ #1065

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 18, 2025
Merged

Add notice to S2 about MinLZ #1065

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions s2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# MinLZ

I have taken the experiences from this library and created a backwards compatible compression package called MinLZ.

That package will seamlessly decode S2 content, making the transition from this package fairly trivial.

There are many improvements to pretty much all aspects of S2 since we have "broken free" of the Snappy format specification.
You can read a writeup on [Design and Improvements over S2](https://gist.github.com/klauspost/a25b66198cdbdf7b5b224f670c894ed5).

The only aspect not covered is custom dictionary encoding. While I do intend to fix errors in this package,
I do not expect to make significant improvements, since I consider MinLZ a better basis for going forward.

See https://github.com/minio/minlz for all details.

# S2 Compression

S2 is an extension of [Snappy](https://github.com/google/snappy).
Expand Down
Loading