diff --git a/README.md b/README.md index 8101e5d..ba88fcf 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,8 @@ [![Readme Score](http://readme-score-api.herokuapp.com/score.svg?url=https://github.com/nodes-vapor/gatekeeper)](http://clayallsopp.github.io/readme-score?url=https://github.com/nodes-vapor/gatekeeper) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/nodes-vapor/gatekeeper/master/LICENSE) -GateKeeper is a middleware that restricts the number of requests from clients, based on their IP address. -It works by adding the clients IP address to the cache and count how many requests the clients can make during the GateKeepers defined lifespan and give back an HTTP 429(Too Many Requests) if the limit has been reached. The number of requests left will be reset when the defined timespan has been reached +Gatekeeper is a middleware that restricts the number of requests from clients, based on their IP address. +It works by adding the clients IP address to the cache and count how many requests the clients can make during the Gatekeeper's defined lifespan and give back an HTTP 429(Too Many Requests) if the limit has been reached. The number of requests left will be reset when the defined timespan has been reached **Please take into consideration that multiple clients can be using the same IP address. eg. public wifi** @@ -44,7 +44,7 @@ import Gatekeeper public func setup() throws { // ... - addConfigurable(middleware: GateKeeper(rate: Rate(10, per: .minute)), name: "gatekeeper") + addConfigurable(middleware: Gatekeeper(rate: Rate(10, per: .minute)), name: "gatekeeper") } ```