diff --git a/Cargo.toml b/Cargo.toml index af8e7c7..ae77e85 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,6 +2,13 @@ name = "rtpeeker" version = "0.1.0" edition = "2021" +license = "MIT" +description = "RTP streams analysis and visualization tool" +homepage = "https://github.com/LVala/rtpeeker/" +repository = "https://github.com/LVala/rtpeeker/" +readme = "README.md" +keywords = ["streaming", "RTP", "networking"] +categories = ["development-tools", "multimedia", "visualization"] include = ["/client"] [dependencies] diff --git a/README.md b/README.md index 2c27714..f343f29 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,36 @@ # RTPeeker -_Work in progress_ +![CI](https://img.shields.io/github/actions/workflow/status/LVala/rtpeeker/ci.yml) +![crates.io](https://img.shields.io/crates/v/rtpeeker) + +RTP streams analysis and visualization tool. + +_Work in progress..._ ## Installation -_TODO_ +Supports Linux and MacOS. + +1. RTPeeker depends on `libpcap`, make sure to install it: + +```shell +# installed on MacOS by default + +# for Ubuntu +sudo apt install libpcap-dev + +# for Arch +sudo pacman -S libpcap +``` + +2. RTPeeker itself can be installed using the [Rust toolchain](https://www.rust-lang.org/tools/install): + +```shell +cargo install --locked rtpeeker +``` + +3. Run RTPeeker: + +```shell +rtpeeker --help +``` diff --git a/common/Cargo.toml b/common/Cargo.toml index b162d02..d14ca90 100644 --- a/common/Cargo.toml +++ b/common/Cargo.toml @@ -2,6 +2,11 @@ name = "rtpeeker_common" version = "0.1.0" edition = "2021" +license = "MIT" +description = "Crate with common utilities for rtpeeker" +homepage = "https://github.com/LVala/rtpeeker/" +repository = "https://github.com/LVala/rtpeeker/" +readme = false [dependencies] serde = { version ="1.0", features = ["derive"]}