diff --git a/README.md b/README.md index 9d5bc27..cecce8b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# netbrowse +# NetBrowse [](https://crates.io/crates/netbrowse) [](https://docs.rs/netbrowse) [](https://github.com/Ewpratten/netbrowse/actions/workflows/build.yml) @@ -6,11 +6,14 @@ [](https://github.com/Ewpratten/netbrowse/actions/workflows/audit.yml) -repo description +**NetBrowse** is a graphical frontend to [`avahi-browse`](https://linux.die.net/man/1/avahi-browse). This tool is used to quickly inspect a network for hosts that publicly expose their services. + + +*This screenshot was taken on a public network* ## Installation -This crate can be installed via `cargo` with: +This crate can also be installed via `cargo` with: ```sh cargo install netbrowse diff --git a/screenshot.png b/screenshot.png new file mode 100644 index 0000000..d94537c Binary files /dev/null and b/screenshot.png differ