diff --git a/README.md b/README.md index b7bc975..8e88c0e 100644 --- a/README.md +++ b/README.md @@ -8,3 +8,31 @@ It simply reads from `/proc/net/dev` to obtain byte-counts of the specified network interface and writes to four files, two of which keep track of the total byte count for sending and receiving, and the other two contain the "diffs" for each (configurable) interval (by default 5 seconds). +rust_network_status_rate 0.1.0 + + USAGE: + rust_network_status_rate [FLAGS] [OPTIONS] + + FLAGS: + -s, --disable-scaling Disables byte scaling into interval files + -e, --enable-alt-prefix Enable use of alternate prefix instead of XDG_RUNTIME_DIR + -h, --help Prints help information + -V, --version Prints version information + + OPTIONS: + -p, --prefix Prefix to use instead of XDG_RUNTIME_DIR if enabled [default: /tmp] + -r, --recv-interval + Filename of interval bytes recieved (in prefix dir) [default: rust_recv_interval] + + -d, --recv-total + Filename of total bytes received (in prefix dir) [default: rust_recv_total] + + -s, --send-interval + Filename of interval bytes sent (in prefix dir) [default: rust_send_interval] + + -u, --send-total + Filename of total bytes sent (in prefix dir) [default: rust_send_total] + + + ARGS: +