Bump to v2.0.0, refer CHANGELOG

bsodmike · Sep 8, 2024 · 5a04e69 · 5a04e69
1 parent d9b60f2
commit 5a04e69
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 4 deletions.
diff --git 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
diff --git 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 <michael@cyberdynea.io>"]
 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
@@ -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