From ac825370437ce6d0152941fdbd2a8332a63bb0a3 Mon Sep 17 00:00:00 2001 From: Nils Andreas Svee Date: Mon, 22 Jun 2026 17:03:56 +0700 Subject: [PATCH] docs: clarify applet availability and server implementation status Update README to specify that irtt-tui requires the tui feature and explicitly state that server support is not yet implemented. --- README.md | 6 +++--- crates/irtt-cli/src/cmd/mod.rs | 3 +-- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 27ac202..51d78b9 100644 --- a/README.md +++ b/README.md @@ -48,9 +48,9 @@ cargo run -p irtt-cli --bin irtt-cli -- ``` For space-sensitive packaging, such as OpenWrt packages, distributors can ship -only `irtt-rs` and symlink or hardlink applet names such as `irtt-cli`, -`irtt-tui`, and future server applet names to it. Applet dispatch is based on -the invoked binary name. +only `irtt-rs` and symlink or hardlink enabled applet names such as `irtt-cli` +and, when built with the `tui` feature, `irtt-tui` to it. Applet dispatch is +based on the invoked binary name. Server support is not implemented. cargo-dist release archives are currently configured with the `full` feature set, so target archives bundle the enabled applet binaries: `irtt-rs`, diff --git a/crates/irtt-cli/src/cmd/mod.rs b/crates/irtt-cli/src/cmd/mod.rs index 2ce5c54..bbed2ed 100644 --- a/crates/irtt-cli/src/cmd/mod.rs +++ b/crates/irtt-cli/src/cmd/mod.rs @@ -3,5 +3,4 @@ pub mod client; #[cfg(feature = "tui")] pub mod tui; -// Future command applets, such as a server applet, belong here behind their -// own feature gate. +// Additional command applets belong here behind their own feature gate.