docs: clarify TermiNotes purpose - #4
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
1 participant
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.
Clarifies the README opening so it explains what TermiNotes is, what it does, and why terminal-safe notes matter. Keeps the existing screenshot and feature details.
Note
Low Risk
Documentation-only README edits with no runtime, security, or data-handling impact.
Overview
Rewrites the README intro and “Why TermiNotes?” so newcomers get a clearer picture of the product before installation and feature lists.
The opening no longer uses a single “hyper-lightweight” tagline. It now states that TermiNotes is a menu-bar scratchpad for terminal work, what kinds of content it holds (output, diagrams, tables, multi-line commands), and why plain monospace matters (no smart quotes, wrapping, or unsafe paste). A second paragraph adds layout-sensitive examples (
git log --graph, stack traces, etc.). The annotated-screenshot blurb is tightened to describe menu-bar placement, Shots, terminal-safe copy, Find/Replace, and toggle lists.The Why TermiNotes? section expands the contrast with standard note apps: smart quotes, dash changes, wrapping, and trailing newlines on copied commands—and reframes TermiNotes as a deliberately plain buffer for paste → preserve shape → find/fold → safe copy. Installation, Key Features, and the rest of the README are unchanged.
Reviewed by Cursor Bugbot for commit 6b3d0a9. Bugbot is set up for automated code reviews on this repo. Configure here.