Skip to content

docs: improve README and product positioning - #400

Merged
pando85 merged 2 commits into
masterfrom
docs/improve-readme
Sep 30, 2026
Merged

pando85 merged 2 commits into
masterfrom
docs/improve-readme

Conversation

@pando85

@pando85 pando85 commented Sep 30, 2026

Copy link
Copy Markdown
Owner

Summary

Improve the README so it reflects the current program rather than presenting Timer as only a simple countdown alarm.

Changes

  • clarify the project positioning as a terminal countdown timer and stopwatch
  • add a concise command-oriented introduction with the main use cases
  • document flexible duration syntax and target clock times
  • document loop, silence, terminal bell, and stopwatch usage
  • document stopwatch controls
  • reorganize alarm documentation around normal audio, PC speaker, and terminal bell
  • simplify and clarify installation instructions
  • make the README emphasize Timer's small, configuration-free scope without overselling it

Motivation

The existing README undersells several of Timer's strongest features, particularly target clock times (timer 14:30), the adaptive display, terminal title updates, and the stopwatch. This makes the project look closer to a thin wrapper around sleep than the actual interactive terminal utility it has become.

This PR is intentionally documentation-only and does not change program behavior.

@pando85
pando85 enabled auto-merge (rebase) September 30, 2026 03:14
@pando85
pando85 merged commit 6ea52a6 into master Sep 30, 2026
5 checks passed
@pando85
pando85 deleted the docs/improve-readme branch September 30, 2026 03:16
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.

1 participant