Documentation update

resilience4j · May 26, 2018 · 51d9607 · 51d9607
1 parent 46ad70f
commit 51d9607
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/RELEASENOTES.adoc b/RELEASENOTES.adoc
@@ -157,4 +157,7 @@ NOTE: Breaking changes:
 * Issue #47: OSGI Support. Fixed bnd configuration in publishing.gradle
 
 == Version 0.12.1
-* Issue #212: Fixed r4j-reactor bug when onSubscribe throws an error
+* Issue #212: Fixed r4j-reactor bug when onSubscribe throws an error
+
+== Version 0.13.0
+* PR #234: Non-blocking API for RateLimiter
diff --git a/resilience4j-documentation/src/docs/asciidoc/core_guides/ratelimiter.adoc b/resilience4j-documentation/src/docs/asciidoc/core_guides/ratelimiter.adoc
@@ -23,8 +23,8 @@ RateLimiterConfig config = RateLimiterConfig.builder()
 RateLimiterRegistry rateLimiterRegistry = RateLimiterRegistry.of(config);
 
 // Use registry
-RateLimiter reateLimiterWithDefaultConfig = rateLimiterRegistry.rateLimiter("backend");
-RateLimiter reateLimiterWithCustomConfig = rateLimiterRegistry.rateLimiter("backend#2", config);
+RateLimiter rateLimiterWithDefaultConfig = rateLimiterRegistry.rateLimiter("backend");
+RateLimiter rateLimiterWithCustomConfig = rateLimiterRegistry.rateLimiter("backend#2", config);
 
 // Or create RateLimiter directly
 RateLimiter rateLimiter = RateLimiter.of("NASDAQ :-)", config);
@@ -131,3 +131,9 @@ AtomicRateLimiter atomicLimiter;
 // Estimated time duration in nanos to wait for the next permission
 long nanosToWaitForPermission = atomicLimiter.getNanosToWait();
 ----
+
+
+===== Low level API
+
+If you're interested in making your own thing on top of Resilience4j RateLimiter you'll possibly be interested in
+our lower level APIs like `getPermission` and `reservePermission` methods.