diff --git a/AGENTS.md b/AGENTS.md index af50e30..622553d 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,6 +1,6 @@ # About -`timr-tui` is a TUI to maintain productivity and focus by providing different timers: Pomodoro, Countdown, Timer, Events. +`timr-tui` is a TUI to maintain productivity and focus by providing different timers: Pomodoro, Tabata, Countdown, Timer, Events. Built with Rust using `Ratatui` as the main library. diff --git a/CHANGELOG.md b/CHANGELOG.md index adcd58b..c6cf332 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,6 +14,10 @@ - (notification) show `Pomodoro` or `Tabata` instead of `Countdown` [#209](https://github.com/sectore/timr-tui/pull/209) +### Misc + +- (docs) add `tabata` screen etc. [#209](https://github.com/sectore/timr-tui/pull/209) + ## v1.10.0 - 2026-06-16 ### Features diff --git a/Cargo.toml b/Cargo.toml index f2de471..5ba272a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "timr-tui" version = "1.10.0" -description = "TUI to organize your time: Pomodoro, Countdown, Timer, Event." +description = "TUI to organize your time: Pomodoro, Tabata, Countdown, Timer, Event." edition = "2024" # Reminder: Always keep `channel` in `rust-toolchain.toml` in sync with `rust-version`. rust-version = "1.96.0" @@ -9,7 +9,7 @@ homepage = "https://github.com/sectore/timr-tui" repository = "https://github.com/sectore/timr-tui" readme = "README.md" license = "MIT" -keywords = ["tui", "timer", "countdown", "pomodoro"] +keywords = ["tui", "timer", "countdown", "pomodoro", "tabata"] categories = ["command-line-utilities"] exclude = [ ".github/*", diff --git a/README.md b/README.md index 65955fb..0281a3d 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@ [![crate.io](https://img.shields.io/crates/v/timr-tui)](https://crates.io/crates/timr-tui) [![CI](https://img.shields.io/github/actions/workflow/status/sectore/timr-tui/ci.yml)](https://github.com/sectore/timr-tui/actions/workflows/ci.yml) [![License](https://img.shields.io/crates/l/timr-tui)](./LICENSE) [![Built With Ratatui](https://img.shields.io/badge/Built_With-Ratatui-000?logo=ratatui&logoColor=fff&labelColor=000&color=fff)](https://ratatui.rs/) -TUI to organize your time: Pomodoro, Countdown, Timer, Event. +TUI to organize your time: Pomodoro, Tabata, Countdown, Timer, Event. - `[1] countdown` Use it for your workout, yoga/breathing sessions, meditation, handstand or whatever. - `[2] timer` Check the time on anything you are doing. -- `[3] pomodoro` Organize your working time to be focused all the time by following the [Pomodoro Technique](https://en.wikipedia.org/wiki/Pomodoro_Technique). +- `[3] pomodoro` Organize your working time to be focused all the time by following the [Pomodoro Technique](https://en.wikipedia.org/wiki/Pomodoro_Technique). `Pomodoro` becomes [`Tabata`](https://en.wikipedia.org/wiki/High-intensity_interval_training#Tabata_regimen) by auto-detection. - `[4] event` Count the time for any event in the future or past. # Table of Contents @@ -30,6 +30,12 @@ _(theme depends on your terminal preferences)_ pomodoro +## [Tabata](https://en.wikipedia.org/wiki/High-intensity_interval_training#Tabata_regimen) (auto-detected) + + + tabata + + ## Timer diff --git a/demo/tabata.png b/demo/tabata.png new file mode 100644 index 0000000..c419d31 Binary files /dev/null and b/demo/tabata.png differ diff --git a/demo/tabata.tape b/demo/tabata.tape new file mode 100644 index 0000000..e03624c --- /dev/null +++ b/demo/tabata.tape @@ -0,0 +1,24 @@ +# Note: PR "support ctrl + arrow keys" https://github.com/charmbracelet/vhs/pull/673 needs to be merged to run this `tape`. + +Output demo/tabata.gif + +# https://github.com/charmbracelet/vhs/blob/main/THEMES.md +# Set Theme "AdventureTime" +Set Theme "AlienBlood" + +Set FontSize 14 +Set Width 1000 +Set Height 500 +Set Padding 0 +Set Margin 1 + +# --- START --- +Hide +Type "cargo run -- -r -d -m p --blink on --tabata" +Enter +Sleep .2 +Type "m" # hide menu +Show +# --- SCREENSHOT --- +Screenshot demo/tabata.png +Sleep 1s