Skip to content

Commit 1b3e5ed

Browse files
committed
Add release notes section.
1 parent e7a9e58 commit 1b3e5ed

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

bake.rb

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# frozen_string_literal: true
22

33
# Released under the MIT License.
4-
# Copyright, 2025, by Shopify Inc.
54
# Copyright, 2025, by Samuel Williams.
65

76
# Update the project documentation with the new version number.

readme.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,25 @@ Please see the [project documentation](https://socketry.github.io/async-limiter/
2020

2121
- [Token Usage](https://socketry.github.io/async-limiter/guides/token-usage/index) - This guide explains how to use tokens for advanced resource management with `async-limiter`. Tokens provide sophisticated resource handling with support for re-acquisition and automatic cleanup.
2222

23+
## Releases
24+
25+
Please see the [project releases](https://socketry.github.io/async-limiter/releases/index) for all releases.
26+
27+
### v2.0.0
28+
29+
The 2.0.x release should be considered somewhat unstable.
30+
31+
- **Breaking**: Complete API redesign. The v1.x classes (`Async::Limiter::Concurrent`, `Async::Limiter::Unlimited`, etc.) have been replaced with a new inheritance-based architecture.
32+
- **Breaking**: Removed `blocking?` method due to inherent race conditions. Use `acquire(timeout: 0)` for non-blocking checks.
33+
- **Breaking**: Timing strategies now use consumption-only model (no explicit `release` methods).
34+
- **Breaking**: Window classes moved from `limiter/window/` to `limiter/timing/` with renamed classes.
35+
- [New Architecture (replaces v1.x classes)](https://socketry.github.io/async-limiter/releases/index#new-architecture-\(replaces-v1.x-classes\))
36+
- [Advanced Timeout Features](https://socketry.github.io/async-limiter/releases/index#advanced-timeout-features)
37+
- [Cost-Based Acquisition](https://socketry.github.io/async-limiter/releases/index#cost-based-acquisition)
38+
- [Enhanced Timing Strategies](https://socketry.github.io/async-limiter/releases/index#enhanced-timing-strategies)
39+
- [Token-Based Resource Management](https://socketry.github.io/async-limiter/releases/index#token-based-resource-management)
40+
- [Thread Safety and Performance](https://socketry.github.io/async-limiter/releases/index#thread-safety-and-performance)
41+
2342
## See Also
2443

2544
- [falcon](https://github.com/socketry/falcon) - A high-performance web server

0 commit comments

Comments
 (0)