From a5443f5df72ec39627af544d2bdc82f45ddddaa4 Mon Sep 17 00:00:00 2001 From: Stevan Freeborn <65925598+StevanFreeborn@users.noreply.github.com> Date: Wed, 22 Jul 2026 23:16:54 -0500 Subject: [PATCH] docs: update README.md --- README.md | 89 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 47 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index 168271f..106c261 100644 --- a/README.md +++ b/README.md @@ -21,48 +21,10 @@ When termato is running, control the application using the following keys: | Q / q | Quit the application cleanly | | Ctrl + C | Force quit the application cleanly | -> [!NOTE] +> [!NOTE] > The in-app help overlay (`?`) requires a minimum terminal window size to be displayed. -## Getting Started - -### Prerequisites - -Ensure you have Rust and Cargo installed. If not, download them via [rustup.rs](https://rustup.rs/). - -### Running with Defaults - -To run termato with the default settings (25-minute focus session, 5-minute break): - -```bash -cargo run --release -``` - -### Specifying Custom Session Times - -You can specify custom session durations as command-line arguments in minutes: - -```bash -cargo run --release -- [work_minutes] [break_minutes] -``` - -For example, to run a 50-minute focus session followed by a 10-minute break: - -```bash -cargo run --release -- 50 10 -``` - -### Help and Version - -To print the help message or version directly without entering the TUI: - -```bash -cargo run --release -- -h -cargo run --release -- --help -cargo run --release -- --version -``` - -## Building and Installation +## Installation To install `termato` using the automated installers: @@ -78,12 +40,55 @@ curl --proto '=https' --tlsv1.2 -LsSf https://github.com/StevanFreeborn/termato/ irm https://github.com/StevanFreeborn/termato/releases/latest/download/termato-installer.ps1 | iex ``` -To install `termato` globally from source using Cargo: +## Getting Started + +### Running with Defaults + +To run termato with the default settings (25-minute focus session, 5-minute break): + +```bash +termato +``` + +### Specifying Options and Custom Session Times + +By default, desktop notifications are disabled. You can specify options and custom session durations as command-line arguments: + +```bash +termato [options] [work_minutes] [break_minutes] +``` + +For example, to enable desktop notifications and run a 50-minute focus session followed by a 10-minute break: + +```bash +termato -n 50 10 +``` + +Or using the long flag: + +```bash +termato --notify 50 10 +``` + +### Help and Version + +To print the help message or version directly without entering the TUI: + +```bash +termato -h +termato --help +termato --version +``` + +## Building and Installing from Source + +To install `termato` globally from source (requires Rust and Cargo): + ```bash cargo install --path . ``` -Alternatively, to build a standalone optimized binary manually: +Alternatively, to build a standalone optimized binary manually from source (requires Rust and Cargo): ```bash cargo build --release