Skip to content

Commit

Permalink
Fix Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jkallio committed Jan 18, 2024
1 parent ae3a028 commit 011d2b2
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 7 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "pomodoro-cli"
version = "1.2.0"
version = "1.2.1"
authors = ["Jussi Kallio <jkallio@gmail.com>"]
license = "MIT"
description = "A simple command line Pomodoro timer."
Expand Down
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Pomodoro timer is a simple timer that helps you to stay focused on your tasks.

### Download binary

- [pomodoro cli (v.1.1.0)](https://github.com/jkallio/pomodoro-cli/releases/tag/v1.1.0)
- [pomodoro cli (v.1.2.1)](https://github.com/jkallio/pomodoro-cli/releases/tag/v1.2.1)

### Cargo

Expand All @@ -30,18 +30,19 @@ $ cargo install pomodoro-cli
- [x] Start/Stop the Timer
- [x] Query the Timer status
- [x] Add more time to a running timer.
- [x] Wait for the Timer to finish (v1.2.0)
- [x] Triggers system notification when the Timer is finished
- [x] Play alarm sound when the Timer is finished
- [x] Easy Waybar integration
- [x] Customize notification icon
- [x] Customize alarm sound
- [x] Customize notification icon and alarm sound

# Usage

Options for `start`:
- `--duration` Set the duration for the timer (format: `1h 30m 15s`)
- `--notify` Triggers system notification when the timer is finished (default: disabled)
- `--silent` Do not play alarm sound when the timer is finished (default: enabled)
- `--wait` Wait for the timer to finish (default: disabled)

### Start/Stop the timer

Expand Down Expand Up @@ -121,8 +122,8 @@ If you want to signal Waybar to update the module immediately when you can add `

```json
"custom/pomo": {
on-click": "pomodoro-cli start --duration 5m; pkill -SIGRTMIN+10 waybar",
signal": 10,
"on-click": "pomodoro-cli start --duration 5m; pkill -SIGRTMIN+10 waybar",
"signal": 10,
}
```

Expand Down
Binary file modified assets/screenshot_waybar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 011d2b2

Please sign in to comment.