File: rename utility to ss-decode

SeaQL · Dec 4, 2023 · 21cc6ea · 21cc6ea
1 parent 02d7a97
commit 21cc6ea
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -387,10 +387,16 @@ i.e. round-robin.
 We provide a small utility to decode `.ss` files:
 
 ```sh
-alias decoder='cargo run --package sea-streamer-file --features=executables --bin decoder'
-decoder -- --file <file> --format <format>
- # or if you wish to install it
-cargo install sea-streamer-file --features=executables --bin decoder
+cargo install sea-streamer-file --features=executables --bin ss-decode
+ # local version
+alias ss-decode='cargo run --package sea-streamer-file --features=executables --bin ss-decode'
+ss-decode -- --file <file> --format <format>
+```
+
+Pro tip: pipe it to `less` for pagination
+
+```sh
+ss-decode --file mystream.ss | less
 ```
 
 Example `log` format:

diff --git a/build-tools/cargo-readme.sh → build-tools/readme.sh b/build-tools/cargo-readme.sh → build-tools/readme.sh
diff --git a/sea-streamer-file/Cargo.toml b/sea-streamer-file/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "sea-streamer-file"
-version = "0.3.8"
+version = "0.3.9"
 authors = ["Chris Tsang <[email protected]>"]
 edition = "2021"
 description = "🌊 SeaStreamer File Backend"
@@ -47,7 +47,7 @@ path = "src/bin/clock.rs"
 required-features = ["executables"]
 
 [[bin]]
-name = "decoder"
+name = "ssdecode"
 path = "src/bin/decoder.rs"
 required-features = ["executables"]
 

diff --git a/sea-streamer-file/README.md b/sea-streamer-file/README.md
@@ -26,10 +26,16 @@ i.e. round-robin.
 We provide a small utility to decode `.ss` files:
 
 ```sh
-alias decoder='cargo run --package sea-streamer-file --features=executables --bin decoder'
-decoder -- --file <file> --format <format>
- # or if you wish to install it
-cargo install sea-streamer-file --features=executables --bin decoder
+cargo install sea-streamer-file --features=executables --bin ss-decode
+ # local version
+alias ss-decode='cargo run --package sea-streamer-file --features=executables --bin ss-decode'
+ss-decode -- --file <file> --format <format>
+```
+
+Pro tip: pipe it to `less` for pagination
+
+```sh
+ss-decode --file mystream.ss | less
 ```
 
 Example `log` format:

diff --git a/sea-streamer-file/src/lib.rs b/sea-streamer-file/src/lib.rs
@@ -26,10 +26,16 @@
 //! We provide a small utility to decode `.ss` files:
 //!
 //! ```sh
-//! alias decoder='cargo run --package sea-streamer-file --features=executables --bin decoder'
-//! decoder -- --file <file> --format <format>
-//!  # or if you wish to install it
-//! cargo install sea-streamer-file --features=executables --bin decoder
+//! cargo install sea-streamer-file --features=executables --bin ss-decode
+//!  # local version
+//! alias ss-decode='cargo run --package sea-streamer-file --features=executables --bin ss-decode'
+//! ss-decode -- --file <file> --format <format>
+//! ```
+//! 
+//! Pro tip: pipe it to `less` for pagination
+//! 
+//! ```sh
+//! ss-decode --file mystream.ss | less
 //! ```
 //!
 //! Example `log` format: