diff --git a/README.md b/README.md index da21500..69c96bf 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,23 @@ # upload-baker -Auto-adjusts cake (or similar qdisc with bandwidth option) for your upload based on latency. \ No newline at end of file +Auto-adjusts cake (or similar qdisc with bandwidth option) for your upload based on latency. + +## How it works + +`upload-baker` monitors your latency to a configurable host periodically. +As soon as the latency goes above the configured value (e.g. 50ms), it throttles the upload bandwidth. + +### Examples +Some examples below, recorded with telegraf & rendered with grafana. + +#### Throttling +![](https://git.harting.dev/anonfunc/upload-baker/raw/branch/master/doc/image_down.png) + +#### Recovery + +![](https://git.harting.dev/anonfunc/upload-baker/raw/branch/master/doc/image_ramp-up.png) + +## Limitations +The mechanism used is not perfect, meaning increased latency +can have more possibly causes than varying upload bandwidth from your isp +(which is the main goal this project tries to solve). \ No newline at end of file