Prepare for 0.1.0 release

.github/workflows/ci.yml

@@ -32,7 +32,7 @@ jobs:
         run: cargo binstall --no-confirm --version ~0.18 trunk
       - name: Compile the client
         working-directory: ./client
-        run: trunk build --release
+        run: trunk build --release --dist ../dist
       - name: Install rtpeeker
         run: cargo install --locked --path .
 

Cargo.toml

@@ -2,7 +2,14 @@
 name = "rtpeeker"
 version = "0.1.0"
 edition = "2021"
-include = ["/client"]
+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 = ["/dist/"]
 
 [dependencies]
 rtpeeker_common = { path = "./common", version = "0.1" }

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. Install RTPeeker using the [Rust toolchain](https://www.rust-lang.org/tools/install):
+
+```shell
+cargo install --locked rtpeeker
+```
+
+3. Run RTPeeker:
+
+```shell
+rtpeeker --help
+```

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"]}

src/server.rs

@@ -23,7 +23,7 @@ const WS_PATH: &str = "ws";
 static NEXT_CLIENT_ID: AtomicUsize = AtomicUsize::new(1);
 
 #[derive(RustEmbed)]
-#[folder = "client/dist"]
+#[folder = "dist"]
 struct Asset;
 
 struct Client {