Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
klauspost authored Jun 5, 2020
1 parent 31108c0 commit 418e747
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions huff0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ but it can be used as a secondary step to compressors (like Snappy) that does no

* [Godoc documentation](https://godoc.org/github.com/klauspost/compress/huff0)

THIS PACKAGE IS NOT CONSIDERED STABLE AND API OR ENCODING MAY CHANGE IN THE FUTURE.

## News

* Mar 2018: First implementation released. Consider this beta software for now.
Expand Down Expand Up @@ -75,6 +73,8 @@ which can be given to the decompressor.
Decompressing is done by calling the [`Decompress1X`](https://godoc.org/github.com/klauspost/compress/huff0#Scratch.Decompress1X)
or [`Decompress4X`](https://godoc.org/github.com/klauspost/compress/huff0#Scratch.Decompress4X) function.

For concurrently decompressing content with a fixed table a stateless [`Decoder`](https://godoc.org/github.com/klauspost/compress/huff0#Decoder) can be requested which will remain correct as long as the scratch is unchanged. The capacity of the provided slice indicates the expected output size.

You must provide the output from the compression stage, at exactly the size you got back. If you receive an error back
your input was likely corrupted.

Expand All @@ -84,4 +84,4 @@ There are no integrity checks, so relying on errors from the decompressor does n
# Contributing

Contributions are always welcome. Be aware that adding public functions will require good justification and breaking
changes will likely not be accepted. If in doubt open an issue before writing the PR.
changes will likely not be accepted. If in doubt open an issue before writing the PR.

0 comments on commit 418e747

Please sign in to comment.