Add project status section in README

This commit is contained in:
cyqsimon
2023-08-30 11:44:43 +08:00
parent 53af5b8e2f
commit 20410739d7

View File

@@ -8,6 +8,7 @@ This is a CLI utility for displaying current network utilization by process, con
- [bandwhich](#bandwhich)
- [Table of contents](#table-of-contents)
- [Project status](#project-status)
- [How does it work?](#how-does-it-work)
- [Installation](#installation)
- [Download a prebuilt binary](#download-a-prebuilt-binary)
@@ -30,6 +31,14 @@ This is a CLI utility for displaying current network utilization by process, con
- [Contributing](#contributing)
- [License](#license)
## Project status
This project is in passive maintenance. Critical issues will be addressed, but
no new features are being worked on. However, this is due to a lack of funding
and/or manpower more than anything else, so pull requests are more than welcome.
For more details, see [The Future of Bandwhich #275](https://github.com/imsnif/bandwhich/issues/275).
## How does it work?
`bandwhich` sniffs a given network interface and records IP packet size, cross referencing it with the `/proc` filesystem on linux, `lsof` on macOS, or using WinApi on windows. 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.