Added documentation

jaytaph · Nov 13, 2014 · d87eaf5 · d87eaf5
1 parent 3c198b7
commit d87eaf5
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -44,6 +44,7 @@ public function getConfigTreeBuilder()
                 ->end()
                 ->scalarNode('rate_response_exception')
                     ->defaultNull()
+                    ->info('Optional exception class that will be returned when a client hits the rate limit')
                     ->validate()
                         ->always(function ($item) {
                             if (! is_subclass_of($item, '\Exception')) {

diff --git a/README.md b/README.md
@@ -224,6 +224,13 @@ class RateLimitGenerateKeyListener
 
 Make sure to generate a key based on what is rate limited in your controllers.
 
+
+## Throwing exceptions
+
+Instead of returning a Response object when a rate limit has exceeded, it's also possible to throw an exception. This 
+allows you to easily handle the rate limit on another level, for instance by capturing the ``kernel.exception`` event. 
+
+
 ## Running tests
 
 If you want to run the tests use: