add brotli option to README.md, remove gzip from update/replace

isaacs / node-tar

tar for node

ISC License

837 stars 183 forks source link

add brotli option to README.md, remove gzip from update/replace #403

Closed itchyny closed 6 months ago

itchyny commented 6 months ago

This PR updates README.md with the following changes:

adds brotli option to tar.c and tar.Pack
removes gzip option from tar.update and tar.replace
fixes some typos

isaacs commented 6 months ago

I appreciate you noticing and sending this doc update.

I'm eyeballs deep right now in converting this lib to typescript, and moving all of these config descriptions into the tsdoc comments, so I'm not going to land it as-is, but I'll incorporate it into the work that I'm doing now. Should land in the next few days. Thanks!

itchyny commented 6 months ago

Okay, thanks. That's a way better! I find it hard to read and correct the list of parameters in README.