Skip to content

Add settings documentation to README#34

Merged
justincampbell merged 3 commits intomainfrom
add-settings-documentation
Nov 20, 2025
Merged

Add settings documentation to README#34
justincampbell merged 3 commits intomainfrom
add-settings-documentation

Conversation

@justincampbell
Copy link
Copy Markdown
Member

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

Copy link
Copy Markdown
Member Author

@justincampbell justincampbell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Testing

README.md Outdated
Create or edit `~/.pomodoro/settings`:

```
daily_goal=8 default_pomodoro_duration=25m default_break_duration=5m default_tags=work,focus
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@claude These should be on separate lines

justincampbell and others added 2 commits September 24, 2025 10:28
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>
🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@justincampbell justincampbell force-pushed the add-settings-documentation branch from d8a159c to 1ae4689 Compare September 24, 2025 14:29
Copilot AI review requested due to automatic review settings September 24, 2025 14:29
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds comprehensive documentation for configuration options in the go-openpomodoro library. The documentation explains how users can customize the Pomodoro CLI behavior through a settings file.

  • Documents four key configuration options: daily_goal, default_pomodoro_duration, default_break_duration, and default_tags
  • Provides example settings file and duration format guide
  • Explains how settings are automatically applied in different CLI operations

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

- Remove quotes from default duration values
- Document that plain numbers default to minutes
- Add finish --break to list of commands using settings

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@justincampbell justincampbell merged commit 5d88119 into main Nov 20, 2025
2 checks passed
@justincampbell justincampbell deleted the add-settings-documentation branch November 20, 2025 15:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants