[add][fix] added readme and fixed plot.sh name in --help

README.md

@@ -0,0 +1,97 @@
+<h1 align="center">PingPlot</h1>
+
+<h4 align="center">
+	Want to create <strike>memes</strike> graphs of your network connectivity? Ping and plot away:
+</h4><br>
+<p align="center">
+<img src="docs/internet.png" width="800px">
+</p>
+
+## Getting started
+
+> **DISCLAIMER:** The author accepts no responsibility or liablity for the use of this software. A high frequency of `ICMP` requests could be seen as `DoS` attack. Please ensure you have permission to ping the target servers!  
+In the default configuration a server will be pinged `10` times with `0.2s` between each ping every `60s`.
+
+This tool requires `net-tools` (if not using a docker container) and `gnuplot` installed on the system.
+
+1. Configure the servers to be pinged and their label in the graph's legend in the [`servers.env`](servers.env) file:
+    ```
+    <domain or ip>:<label>
+    0.0.0.0:localhost
+    my_server.x:my-server
+    ```
+    Note that `gnuplot` will interprets some carachters (such as `_` underscore) in `<label>` as mathematic notation. 
+
+2. Run [`./files/inet_stat.sh`](files/inet_stat.sh) or start a docker container which includes the script with `docker-compose up`
+
+3. Plot the data with [`./plotter/plot.sh`](plotter/plot.sh)
+
+## Advanced Configuration
+
+### Plot
+
+The `./plotter/plot.sh` script offers a variety of options to control the output of the graph.
+
+```
+    usage: SERVER:LABEL [...]
+           [--file|-f CSV_FILE] [--limit-y|-l Y_MAX] [--time-zone|-t UTC_HOURS]
+           [--start-date|-S DATE] [--end-date|-E DATE] [--show-hours|-H HOURS]
+           [--align-legend|-a POSITION]
+```
+Examples:
+```bash
+./plotter/plot.sh example.local:example 0.0.0.0:localhost --limit-y 100 --show-hours 5 --end-date "2021-03-03 20:11" --time-zone -5
+
+./plotter/plot.sh example.local:example 0.0.0.0:localhost -S 2021-03-02 -E 2021-03-03 -f data.csv
+```
+
+Run [`./plotter/plot.sh --help`](plotter/plot.sh) for details.
+
+### Ping
+
+The script `./files/inet_stat.sh` which pings the target servers and records the data can be configured via environment variables:
+```bash
+# space seperated list of servers (takes precedence over servers.env)
+SERVERS="127.0.0.1
+         0.0.0.0
+         localhost"
+
+# sets the cycle at which servers are pinged `sleep $CYCLE` [default: 60s]
+CYCLE=60s
+
+# sets the amount of times servers are pinged on each cycle [default: 10]
+PING_COUNT=10
+
+# sets the output file name [default: ping.csv]
+OUTPUT_FILE=ping.csv
+
+# sets the directory path of the output file [default: ./data]
+OUTPUT_PATH=./data
+
+# sets the servers.env file path [default: ./servers.env]
+SERVER_FILE=./servers.env
+
+# changes the Epoch columns format `date $DATE_FORMAT`, e.g. -Iseconds, [default: +%s]
+# ONLY change if you want to use the csv file for another purpose
+# any change from the default will prevent plotting using ./plotter/plot.sh
+DATE_FORMAT=+%s
+```
+
+These can also be set in the `docker-compose.yml` in the `environment` section.
+
+### Latency Data
+
+Latency data is saved in [`data/ping.csv`](data/ping.csv). You can add your own data as long as it has the following format (first line has the column names):
+
+```csv
+Epoch,Server,PacketLoss,Min,Average,Max,Deviation
+1613501993,localhost,0%,87.519,89.085,91.4,1.106
+1613501995,0.0.0.0,0%,120.358,122.399,126.254,1.712
+1613501997,127.0.0.1,0%,113.125,116.473,125.609,3.311
+```
+Viewed in table form:
+| *(UNIX)* Epoch      | Server    | PacketLoss | Min     | Average | Max     | Deviation |
+|------------|-----------|------------|---------|---------|---------|-----------|
+| 1613501993 | localhost | 0%         | 87.519  | 89.085  | 91.4    | 1.106     |
+| 1613501995 | 0.0.0.0   | 0%         | 120.358 | 122.399 | 126.254 | 1.712     |
+| 1613501997 | 127.0.0.1 | 0%         | 113.125 | 116.473 | 125.609 | 3.311     |

plotter/plot.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 function help() { cat; }<<EOF
-Backup Script Version $script_version
+PingPlot Plotter Script
     usage: SERVER:LABEL [...]
            [--file|-f CSV_FILE] [--limit-y|-l Y_MAX] [--time-zone|-t UTC_HOURS]
            [--start-date|-S DATE] [--end-date|-E DATE] [--show-hours|-H HOURS]