From 3dffee7272a35ffe06aa4ded45fa30aee3da75b8 Mon Sep 17 00:00:00 2001
From: Martino Trevisan <martino.trevisan@polito.it>
Date: Wed, 4 Dec 2019 17:25:38 +0100
Subject: [PATCH] initial commit

---
 README.md | 35 ++++++++++++++++++++++++++++++++++-
 1 file changed, 34 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index cab7ac4..5891d32 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,35 @@
-# mobile-network-emulator
+Mobile Network Emulator
+=======================
+
 Realistic Emulation of Mobile Networks
+
+## Prerequisites
+
+This tool runs on Linux, and builds on top of the `tc-netem` tool.
+It also uses the `ifb` kernel module to shape incoming traffic.
+
+The tool is able to emulate profiles available in the `profiles.csv` file.
+Check it to have the complete list.
+
+## Usage
+
+You need to execute it as `root`.
+
+Usage:
+```
+apply_shaping.sh -o operator -c country -t technology -q quality -i interface [-r] [-d] [-h]
+```
+
+Parameters are:
+* `operator`: the Mobile Network Operator to emulate.
+* `country`: the country network to emulate.
+* `technology`: whether to emulate 3G or 4G.
+* `quality`: signal quality to emulate: bad, medium or good.
+* `interface`: the name of the interface where to apply shaping.
+* `-r`: stop doing traffic shaping.
+* `-d`: dry run (only print all commands that would execute).
+* `-h`: print help.
+
+## Limitations
+
+Due to the use of the `ifb` kernel module, you can impose shaping to one interface at a time.