From 1674efa1a7c3ee007b250a3a8b70eff3f5724a4e Mon Sep 17 00:00:00 2001 From: Aram Drevekenin Date: Tue, 10 Sep 2019 22:41:03 +0200 Subject: docs(readme): initial --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 00d7bdd..c5e0168 100644 --- a/README.md +++ b/README.md @@ -1 +1,11 @@ -WIP +### what +Display current network utilization by process and connection. + +This is my first attempt at Rust and is still very much a WIP. :) + +### How does it work? +`what` sniffs a given network interface (provided as the second cli argument, eg. `what eth0`) and records packet size, cross referencing it with the `/proc` filesystem. + +Currently, it relies on the display loop to reset its state every second and thus always display the bandwidth per second. + +At the moment there is only a linux implementation but the tests should (hopefully!) run on all platforms. -- cgit v1.2.3