docs: improve README formatting and clarity#77
Merged
Conversation
Split the multi-command fenced blocks (pipx/uv install, basic usage, quick examples, contributing) into one block per independent command so each gets its own copy button; the Homebrew block stays together since its three lines are a single sequential install procedure. https://claude.ai/code/session_01YMabdRNxaa9sJVdJzhhZk4
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
2 participants
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.
Improve the README's readability and structure by breaking up code examples and adding descriptive headers.
Changes:
These changes maintain all existing content while improving the document's scannability and user experience, particularly for users looking for specific commands or installation methods.
https://claude.ai/code/session_01YMabdRNxaa9sJVdJzhhZk4