Skip to content

Commit d8a159c

Browse files
Add settings documentation to README
Document the available configuration options in the go-openpomodoro library: - daily_goal: Daily Pomodoro target count - default_pomodoro_duration: Default work session duration - default_break_duration: Default break duration - default_tags: Default tags for new Pomodoros Include example settings file, duration format guide, and usage information. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent a689164 commit d8a159c

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
* [Status Format](#status-format)
2020
* [Available Parts](#available-parts)
2121
* [Hooks](#hooks)
22+
* [Settings](#settings)
2223

2324
## Installation
2425

@@ -286,3 +287,38 @@ say "Pomodoro started"
286287
```shellsession
287288
$ chmod +x ~/.pomodoro/hooks/start
288289
```
290+
291+
## Settings
292+
293+
The Pomodoro CLI can be configured using a `settings` file in your configuration directory (`~/.pomodoro/settings`). The settings file uses the logfmt format.
294+
295+
### Available Settings
296+
297+
* `daily_goal` - The number of Pomodoros you want to complete each day (integer, default: 0 = no goal)
298+
* `default_pomodoro_duration` - Default duration for work sessions (duration string, default: "25m")
299+
* `default_break_duration` - Default duration for breaks (duration string, default: "5m")
300+
* `default_tags` - Default tags to apply to new Pomodoros (comma-separated strings, default: none)
301+
302+
### Example Settings File
303+
304+
Create or edit `~/.pomodoro/settings`:
305+
306+
```
307+
daily_goal=8 default_pomodoro_duration=25m default_break_duration=5m default_tags=work,focus
308+
```
309+
310+
### Duration Format
311+
312+
Duration values can be specified in the following formats:
313+
* Minutes: `25m`, `30m`
314+
* Seconds: `90s`, `1500s`
315+
* Mixed: `25m30s`, `1h30m`
316+
317+
### Using Settings
318+
319+
Settings are automatically applied when:
320+
* Starting a new Pomodoro (`pomodoro start`)
321+
* Taking a break (`pomodoro break`)
322+
* Displaying daily progress in status format (`%c/%g`)
323+
324+
The daily goal setting is used by the status format parts `%g` (goal) and `%c` (completed today) to show progress toward your daily target.

0 commit comments

Comments
 (0)