summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAram Drevekenin <aram@poor.dev>2019-10-17 22:18:27 +0200
committerAram Drevekenin <aram@poor.dev>2019-10-17 22:18:27 +0200
commita2bec036f1c100b548c3850dd2bd5e86afb6ee71 (patch)
tree8780b4ee7c3d0c4c8e30e8c1a1c2c32c33afec12
parent3780e56fe85d44c27cb287c0a7b08f4bf5d8d3d1 (diff)
parent79d54be823e55fe7d27e289ca1894595f0fbb3d9 (diff)
Merge branch 'master' of https://github.com/imsnif/what
-rw-r--r--README.md20
1 files changed, 14 insertions, 6 deletions
diff --git a/README.md b/README.md
index c5e0168..d1ff4e4 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,19 @@
-### what
-Display current network utilization by process and connection.
+## what
+...is taking up my bandwidth?!
-This is my first attempt at Rust and is still very much a WIP. :)
+![demo](demo.gif)
+
+(display current network utilization by process, connection and remote IP/hostname)
+
+This is my first attempt at Rust. :)
### 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.
+`what` sniffs a given network interface and records IP packet size, cross referencing it with the `/proc` filesystem. It is responsive to the terminal window size, displaying less info if there is no room for it. It will also attempt to resolve ips to their host name in the background using reverse DNS on a best effort basis.
+
+### Installation
+At the moment, `what` is available through Cargo as a binary package.
-Currently, it relies on the display loop to reset its state every second and thus always display the bandwidth per second.
+### Usage
+`what -i <interface-name>` eg. `what -i eth0`
-At the moment there is only a linux implementation but the tests should (hopefully!) run on all platforms.
+Note that since `what` sniffs network packets, it requires root privileges - so you might want to use it with (for example) `sudo`.