diff --git a/README.md b/README.md index a6826c3..8776bfd 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ ## About -Gor is simple http traffic replication tool written in Go. -Its main goal to replay traffic from production servers to staging and dev environments. +Gor is a simple http traffic replication tool written in Go. +Its main goal is to replay traffic from production servers to staging and dev environments. Now you can test your code on real user sessions in an automated and repeatable fashion. @@ -9,8 +9,9 @@ Now you can test your code on real user sessions in an automated and repeatable Gor consists of 2 parts: listener and replay servers. -Listener catch http traffic from given port in real-time and send it to replay server via UDP. -Replay server forwards traffic to given address. +The listener server catches http traffic from a given port in real-time +and sends it to the replay server via UDP. +The replay server forwards traffic to a given address. ![Diagram](http://i.imgur.com/zZCFPCY.png) @@ -29,16 +30,19 @@ gor replay -f http://staging.server ## Advanced use ### Rate limiting -Replay server support rate limiting. It can be useful if you want forward only part of production traffic, not to overload staging environment. You can specify desired request per second using "|" operator after server address: +The replay server supports rate limiting. It can be useful if you want +forward only part of production traffic and not overload your staging +environment. You can specify your desired requests per second using the +"|" operator after the server address: ``` -# staging.server not get more than 10 requests per second +# staging.server will not get more than 10 requests per second gor replay -f "http://staging.server|10" ``` ### Forward to multiple addresses -You can forward traffic to multiple endpoints. Just separate addresses by coma. +You can forward traffic to multiple endpoints. Just separate the addresses by coma. ``` gor replay -f "http://staging.server|10,http://dev.server|5" ``` @@ -68,11 +72,12 @@ Usage of ./bin/gor-linux: ## FAQ -### Why `gor listener` requires sudo or root access? -Listener works by sniffing traffic from given port. Its accessible only using sudo or root access. +### Why does the `gor listener` requires sudo or root access? +Listener works by sniffing traffic from a given port. It's accessible +only by using sudo or root access. ### Do you support all http request types? -Right now it support only "GET" requests. +Right now it supports only "GET" requests. ## TODO