Document PyPI as the primary install path - #5
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.
What changed
pipx install hermes-plugin-guardthe primary command in the beta quickstart and install guidedocs/demo.pyto show the PyPI command and v0.1.3 output, then regeneratedocs/demo.gifWhy
v0.1.3 is now available on PyPI, but the documentation still contained release-staging language and a v0.1.2 demo. That made the longer GitHub source installation look like the recommended path.
Impact
New users get the shortest supported one-command installation path. The tagged-source and local-checkout options remain available. This changes documentation only; scanner behavior is unchanged.
Validation
ruff check .ruff format --check .python -m py_compile docs/demo.pypytest --cov=hermes_plugin_guard --cov-report=term-missing— 117 passed, 85% coveragepython -m buildgit diff --checkdocs/demo.gifsuccessfully (20.2 seconds, 84 frames)