diff --git a/CHANGELOG.md b/CHANGELOG.md index 77cbd52..6f4fd6e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 # Unreleased +# 2.0.0 (8 Sept 2024) + +- **added:** Github CI +- **fixed:** Clippy offences - **changed:** Improve docs +- **changed:** Stablised return values to `u64`. Use of `usize` will need to be re-evaluated for future `no-std` support. + +See [PR for changes](https://github.com/bsodmike/better-limit-reader-rs/pull/1/files) + # 1.0.2 (7 Sept 2024) diff --git a/Cargo.lock b/Cargo.lock index 085995d..f83c0da 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -10,7 +10,7 @@ checksum = "512761e0bb2578dd7380c6baaa0f4ce03e84f95e960231d1dec8bf4d7d6e2627" [[package]] name = "better-limit-reader" -version = "1.0.2" +version = "2.0.0" dependencies = [ "derive_builder", "flate2", diff --git a/Cargo.toml b/Cargo.toml index 9cb6bfb..85363b9 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "better-limit-reader" -version = "1.0.2" +version = "2.0.0" authors = ["Michael de Silva "] description = "Configurable limit reader that limits the number of bytes read from an underlying reader, supporting decompression from Gzip and Zlib compressed via `flate2`" readme = "README.md" diff --git a/README.md b/README.md index dc1221d..ad02931 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,22 @@ # better-limit-reader-rs -![Crates.io Version](https://img.shields.io/crates/v/better-limit-reader) +[![Crates.io Version](https://img.shields.io/crates/v/better-limit-reader)](https://crates.io/crates/better-limit-reader) [![Released API docs](https://img.shields.io/docsrs/better-limit-reader)](https://docs.rs/better-limit-reader/) Exposes LimitReader which is a limit reader, that protects against zip-bombs and other nefarious activities that limits the number of bytes read from an underlying reader. This crate is heavily inspired by Jon Gjengset’s “Crust of Rust” episode on the [inner workings of git on YouTube](https://youtu.be/u0VotuGzD_w?si=oIuV9CITSWHJXKBu&t=3503) and mitigrating Zip-bombs. +It has been said, the name is a bit _boisterous_, but at least it sets high ambitions for this wee crate. + ## API usage Refer to the [docs](https://docs.rs/better-limit-reader/latest/better_limit_reader/) for further examples. -### Upcoming enhancements +### Upcoming enhancements (in no particular order) - [ ] Gzip decompression. +- [ ] `no_std` support (?); This needs planning via an issue on Github. - TBD: If you have any requests, please open an issue! ### Building