[tor-commits] [sbws/master] doc: rephrase and add generator scaling part

[juga at torproject.org]

commit 034426a6c24ce380f46777ac76c20a9d61225ee3
Author: juga0 <juga at riseup.net>
Date:   Mon Nov 19 19:22:16 2018 +0000

    doc: rephrase and add generator scaling part
---
 README.md | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 72812b0..93a1653 100644
--- a/README.md
+++ b/README.md
@@ -3,10 +3,13 @@
 [![Build Status](https://travis-ci.org/torproject/sbws.svg?branch=master)](https://travis-ci.org/https://travis-ci.org/torproject/sbws)
 
 Simple Bandwidth Scanner (called `sbws`) is a Tor bandwidth scanner that
-produces bandwidth measurements files to be used by Directory Authorities.
+produces bandwidth files to be used by Directory Authorities.
 
 The scanner builds two hop circuits consisting of the relay being measured and
-a fast exit. Over these circuits it measures bandwidth.
+a fast exit. Over these circuits it measures bandwidth and store the results.
+
+The generator read the measurement results, scales them using torflow's
+scaling method and creates the bandwidth file.
 
 **WARNING**: This software is intended to be run by researchers using a test
 Tor network, such as chutney or shadow, or by the Tor bandwidth authorities