Repository navigation
docs: improve README and product positioning - #400
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Improve the README so it reflects the current program rather than presenting Timer as only a simple countdown alarm.
Changes
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 aroundsleepthan the actual interactive terminal utility it has become.This PR is intentionally documentation-only and does not change program behavior.