docs: overhaul README to production standard - #2
Merged
Conversation
- Add Table of Contents - Add Prerequisites section (macOS, Python 3.10+, terminal-notifier) - Add comparison table showing JigAi vs ntfy, Claude Code Notifier, cmux - Replace dynamic PyPI version badge with static Python version badge (avoids broken badge before first PyPI publish) - Expand Contributing section with branch strategy and commit convention - Fix PyPI first-publish flow: document Pending Publisher option so Trusted Publishing works without a manual first upload - Minor copy improvements throughout
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.
What changed