diff --git a/CHANGELOG.md b/CHANGELOG.md index 2b99d45..57929d0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,15 @@ # Changelog +## v1.0.0 - 2025-01-10 + +Happy `v1.0.0` 🎉 + +### Features + +- (countdown) Mission Elapsed Time ([MET](https://en.wikipedia.org/wiki/Mission_Elapsed_Time)). [#45](https://github.com/sectore/timr-tui/pull/45), [#46](https://github.com/sectore/timr-tui/pull/46) +- (footer) Local time. Optional and with custom formats. [#42](https://github.com/sectore/timr-tui/pull/42), [#43](https://github.com/sectore/timr-tui/pull/43) +- (docs) More installation instructions: Cargo, AUR (Arch Linux) [#41](https://github.com/sectore/timr-tui/pull/41), pre-built release binaries (Linux, macOS, Windows) [#47](https://github.com/sectore/timr-tui/pull/47) + ## v0.9.0 - 2025-01-03 Initial version. @@ -8,5 +18,6 @@ Initial version. - Add `Pomodoro`, `Timer`, `Countdown` - Persist application state -- Change styles +- Custom styles for digits +- Toggle deciseconds - CLI diff --git a/Cargo.lock b/Cargo.lock index d07bf9f..33f6b4b 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1115,7 +1115,7 @@ dependencies = [ [[package]] name = "timr-tui" -version = "0.9.0" +version = "1.0.0" dependencies = [ "clap", "color-eyre", diff --git a/Cargo.toml b/Cargo.toml index 7ea1bf3..adf82d3 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "timr-tui" -version = "0.9.0" +version = "1.0.0" description = "TUI to organize your time: Pomodoro, Countdown, Timer." edition = "2021" rust-version = "1.82.0" diff --git a/README.md b/README.md index b6f94cd..d349ca6 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,9 @@ TUI to organize your time: Pomodoro, Countdown, Timer. - `[c]ountdown` Use it for your workout, yoga session, meditation, handstand or whatever. - `[p]omodoro` Organize your working time to be focused all the time by following the [Pomodoro Technique](https://en.wikipedia.org/wiki/Pomodoro_Technique). -It's built with [`Ratatui`](https://ratatui.rs/) written in [Rust 🦀](https://www.rust-lang.org/). +Built with [Ratatui](https://ratatui.rs/) / [Rust 🦀](https://www.rust-lang.org/). -# Preview +# Features _Side note:_ Theme colors depend on your terminal preferences. @@ -48,6 +48,18 @@ _Side note:_ Theme colors depend on your terminal preferences. menu +## Local time + + + menu + + +## Mission Elapsed Time ([MET](https://en.wikipedia.org/wiki/Mission_Elapsed_Time)) + + + menu + + # CLI ```sh @@ -70,25 +82,35 @@ Options: # Installation -From [crates.io](https://crates.io/crates/timr-tui) run: +## Cargo + +### From [crates.io](https://crates.io/crates/timr-tui) ```sh cargo install timr-tui ``` -Latest version from git repository: +### From GitHub repository ```sh cargo install --git https://github.com/sectore/timr-tui ``` -Arch Linux users can install [from the AUR](https://aur.archlinux.org/packages/timr/): +## Arch Linux + +Install [from the AUR](https://aur.archlinux.org/packages/timr/): ```sh paru -S timr ``` -# Build from source 🔧 + +## Release binaries + +Pre-built artifacts are available to download from [latest GitHub release](https://github.com/sectore/timr-tui/releases). + + +# Development ## Requirements @@ -158,7 +180,7 @@ In `debug` mode only. Locations: ```sh # Linux -~/.local/state/timr/logs/app.log +~/.local/state/timr-tui/logs/app.log # macOS /Users/{user}/Library/Application Support/timr-tui/logs/app.log # `Windows` diff --git a/demo/countdown-met.gif b/demo/countdown-met.gif new file mode 100644 index 0000000..1a55da8 Binary files /dev/null and b/demo/countdown-met.gif differ diff --git a/demo/rocket-countdown.tape b/demo/countdown-met.tape similarity index 81% rename from demo/rocket-countdown.tape rename to demo/countdown-met.tape index e562a5c..e94ede6 100644 --- a/demo/rocket-countdown.tape +++ b/demo/countdown-met.tape @@ -1,7 +1,7 @@ -Output demo/rocket-countdown.gif +Output demo/countdown-met.gif # https://github.com/charmbracelet/vhs/blob/main/THEMES.md -Set Theme "AtomOneLight" +Set Theme "iceberg-light" Set FontSize 14 Set Width 800 diff --git a/demo/rocket-countdown.gif b/demo/rocket-countdown.gif deleted file mode 100644 index f0b448d..0000000 Binary files a/demo/rocket-countdown.gif and /dev/null differ diff --git a/demo/rocket-countdown_no-ds.gif b/demo/rocket-countdown_no-ds.gif new file mode 100644 index 0000000..6df4044 Binary files /dev/null and b/demo/rocket-countdown_no-ds.gif differ diff --git a/justfile b/justfile index d08d9fa..6b31b5b 100644 --- a/justfile +++ b/justfile @@ -49,6 +49,11 @@ alias dc := demo-countdown demo-countdown: vhs demo/countdown.tape +alias dcm := demo-countdown-met + +demo-countdown-met: + vhs demo/countdown-met.tape + alias ds := demo-style demo-style: @@ -72,4 +77,4 @@ demo-local-time: alias drc := demo-rocket-countdown demo-rocket-countdown: - vhs demo/rocket-countdown.tape + vhs demo/met.tape