diff options
| author | Aram Drevekenin <aram@poor.dev> | 2019-10-18 17:53:24 +0200 |
|---|---|---|
| committer | Aram Drevekenin <aram@poor.dev> | 2019-10-18 17:53:24 +0200 |
| commit | 1d943833ba502107f61f9826aff2534b7bc31b83 (patch) | |
| tree | 4401542146b4db28a070fdf0d09795ac936b658b | |
| parent | 592ab2b762b6ff44e39b88022873d0a2cc9b6e25 (diff) | |
chore(docs): adjust readme and add license
| -rw-r--r-- | LICENSE.md | 21 | ||||
| -rw-r--r-- | README.md | 14 |
2 files changed, 32 insertions, 3 deletions
diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..61d556d --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2019 Aram Drevekenin + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. @@ -3,7 +3,7 @@  -(display current network utilization by process, connection and remote IP/hostname) +This is a CLI utility for displaying current network utilization by process, connection and remote IP/hostname This is my first attempt at Rust. :) @@ -11,9 +11,11 @@ This is my first attempt at Rust. :) `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. +At the moment, `what` is available through Cargo as a binary crate. -`cargo install what` +``` +cargo install what +``` Important note: There is only support for linux at the moment, mostly because I don't have access to anything else. I'd very much welcome contributions, and would be happy to provide guidance. Open up an issue/pr if interested. @@ -21,3 +23,9 @@ Important note: There is only support for linux at the moment, mostly because I `what -i <interface-name>` eg. `what -i eth0` Note that since `what` sniffs network packets, it requires root privileges - so you might want to use it with (for example) `sudo`. + +### Contributing +Contributions of any kind are very welcome. If you'd like a new feature, please open an issue or a PR. + +### License +MIT |