From 282927147e1dc0e1d6cf9bfa3c5ae3a3974fd8e7 Mon Sep 17 00:00:00 2001 From: Edmo Vamerlatti Costa <11836452+edmocosta@users.noreply.github.com> Date: Thu, 27 Jun 2024 23:21:41 +0200 Subject: [PATCH] Update README (#6) --- README.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b358e12..676d312 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Tuistash -A Terminal User Interface for Logstash. +A Terminal User Interface (TUI) for monitoring Logstash 🪵 ![demo](docs/img/demo.gif) @@ -15,7 +15,7 @@ brew tap edmocosta/homebrew-tap brew install tuistash ``` -### Manual +### Manually Download the latest release from the [GitHub releases page](https://github.com/edmocosta/tuistash/releases) or build it from the source: 1 - Install Rust and Cargo (Linux and macOS): @@ -65,13 +65,28 @@ Options: ``` -### TUI: +### TUI ```shell ./tuistash ``` -### GET command: +```shell +./tuistash tui --help +``` + +```shell +Logstash TUI + +Usage: tuistash tui [OPTIONS] + +Options: + -i, --interval Refresh interval in seconds [default: 1] +``` + +### Other commands + +#### GET ```shell ./tuistash get node --help