diff options
author | Aram Drevekenin <aram@poor.dev> | 2019-09-10 22:41:03 +0200 |
---|---|---|
committer | Aram Drevekenin <aram@poor.dev> | 2019-09-10 22:41:03 +0200 |
commit | 1674efa1a7c3ee007b250a3a8b70eff3f5724a4e (patch) | |
tree | 275b774c3e57ea9d07cf430e4716b4b4f70babee /README.md | |
parent | 961a3d8ad01fb18227538f148c5a2692443538b2 (diff) |
docs(readme): initial
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 12 |
1 files changed, 11 insertions, 1 deletions
@@ -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. |