~shabbyrobe/go-puff

56157adf54a77a68b3d941230105e38767610196 — Blake Williams 9 months ago 2fb66de
Add install to README
1 files changed, 7 insertions(+), 2 deletions(-)

M README.md
M README.md => README.md +7 -2
@@ 3,6 3,11 @@ Puff

Go port of zlib's [puff.c](https://github.com/madler/zlib/tree/master/contrib/puff).

Install:
```
go get -u go.shabbyrobe.org/puff
```

This is not production-quality code, I haven't polished or finessed it at all.
I wouldn't recommend using it directly without a very specific reason, and even
then I'd suggest pasting it into your own project so you can hack on it in peace


@@ 40,9 45,9 @@ porting stuff from C.
The error handling is not very Go-like at the moment. If I ever decide I need
to use this again, I'll clean that up.

~I also intended to futz around with it to make it able to decompress in-place
<s>I also intended to futz around with it to make it able to decompress in-place
(i.e. to not require a separate output slice) but never got around to that
either.~ Wait this doesn't make much sense and I'm getting confused with something
either.</s> Wait this doesn't make much sense and I'm getting confused with something
else anyway. Stack memory. It was about stack memory. I think. Haha!

Puff is generally slower than `flate.Reader` for common workloads, which is