docs: polish README for PyCon#20
Merged
Merged
Conversation
|
✅ All checks passed! Ready for review. |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the project README to match updated CapiscIO marketing messaging and to better separate primary CLI usage from development/testing utilities, while pointing users to capiscio-core for full CLI documentation.
Changes:
- Rewrites the README intro/positioning and streamlines the “How It Works” explanation.
- Adds “What It Checks”, “Use Cases”, and “Dev & Testing Commands” sections with examples.
- Adds an ecosystem “Related Packages” section and links to external documentation.
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.
Aligns README with marketing copy from capisc.io: