Skip to content

Commit

Permalink
Prepare for 0.1.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
LVala committed Jan 25, 2024
1 parent 184e7de commit e4118bf
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 2 deletions.
7 changes: 7 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
33 changes: 31 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
```
5 changes: 5 additions & 0 deletions common/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"]}
Expand Down

0 comments on commit e4118bf

Please sign in to comment.