update README

biandratti · Dec 15, 2024 · 5139185 · 5139185
1 parent c4dc2b1
commit 5139185
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "passivetcp-rs"
-version = "0.1.0-alpha.1"
+version = "0.1.0-alpha.2"
 edition = "2021"
 description = "Passive traffic fingerprinting [p0f]"
 license = "MIT"

diff --git a/README.md b/README.md
@@ -18,7 +18,11 @@ About passivetcp-rs
 
 This Rust implementation of passive TCP fingerprinting is still in its experimental phase, and while it builds upon the established ideas of p0f, it is not yet feature-complete. The library currently provides basic functionality, but we plan to expand its capabilities as the project matures.
 
-#### A snippet of typical p0f output may look like this:
+### Example
+```
+cargo build --release --examples
+sudo RUST_LOG=info RUST_BACKTRACE=1 ./target/release/examples/p0f -i <INTERFACE> -l <LOG_FILE.LOG>
+```
 
 ```text
 .-[ 1.2.3.4/1524 -> 4.3.2.1/80 (syn) ]-
@@ -62,7 +66,7 @@ This Rust implementation of passive TCP fingerprinting is still in its experimen
 To use passivetcp-rs in your Rust project, add the following dependency to your `Cargo.toml`:
 ```toml
 [dependencies]
-passivetcp-rs = "0.1.0-alpha.0"
+passivetcp-rs = "0.1.0-alpha.2"
 ```
 
 ### Usage