Pierre Curto
dbe9298ce0
#31: updated README to be clearer about LZ4 compatibility
|
7 years ago | |
|---|---|---|
| fuzz | 7 years ago | |
| internal | 7 years ago | |
| lz4c | 7 years ago | |
| testdata | 7 years ago | |
| .gitignore | 7 years ago | |
| .travis.yml | 7 years ago | |
| LICENSE | 10 years ago | |
| README.md | 7 years ago | |
| bench_test.go | 7 years ago | |
| block.go | 7 years ago | |
| block_test.go | 7 years ago | |
| debug.go | 7 years ago | |
| debug_stub.go | 7 years ago | |
| export_test.go | 10 years ago | |
| lz4.go | 7 years ago | |
| lz4_go1.10.go | 7 years ago | |
| lz4_notgo1.10.go | 7 years ago | |
| reader.go | 7 years ago | |
| reader_test.go | 7 years ago | |
| writer.go | 7 years ago | |
| writer_test.go | 7 years ago |
README.md
lz4
LZ4 compression and decompression in pure Go.
Usage
import "github.com/pierrec/lz4"
Description
Package lz4 implements reading and writing lz4 compressed data (a frame), as specified in http://fastcompression.blogspot.fr/2013/04/lz4-streaming-format-final.html.
This package is compatible with the LZ4 frame format although the block level compression and decompression functions are exposed and are fully compatible with the lz4 block format definition, they are low level and should not be used directly.
For a complete description of an lz4 compressed block, see: http://fastcompression.blogspot.fr/2011/05/lz4-explained.html
See https://github.com/Cyan4973/lz4 for the reference C implementation.