source/bandwhich
1
0
Fork 0
mirror of https://github.com/imsnif/bandwhich.git synced 2026-02-08 17:49:19 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): adjust readme and add license

Browse Source
This commit is contained in:
Aram Drevekenin
2019-10-18 17:53:24 +02:00
parent 592ab2b762
commit 1d943833ba
2 changed files with 32 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
LICENSE.md Normal file
View File

@@ -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.

14
README.md
View File

@@ -3,7 +3,7 @@
![demo](demo.gif)
(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