Skip to content

doc: improve readme#8

Merged
lhoupert merged 1 commit into
mainfrom
doc--improve-readme
Mar 27, 2026
Merged

doc: improve readme#8
lhoupert merged 1 commit into
mainfrom
doc--improve-readme

Conversation

@lhoupert
Copy link
Copy Markdown
Collaborator

This pull request updates the README.md to clarify the purpose and value proposition of the GitHub Action, focusing on when and why to use it. The changes make the documentation more concise and user-focused, replacing a feature comparison table with a clearer explanation of the action’s unique benefits.

Documentation improvements:

  • Rewrote the introduction to clarify that the action is a wrapper for both Bandit and pip-audit, and simplified the language for better readability.
  • Replaced the feature comparison table with a narrative explanation of scenarios where this action is useful, emphasizing its unified reporting and workflow enhancements.
  • Listed the main added features: unified PR comment, workflow step summary, configurable blocking on fixable vulnerabilities, and automatic requirements export for different package managers.

@lhoupert lhoupert merged commit df9d84d into main Mar 27, 2026
3 of 4 checks passed
@lhoupert lhoupert deleted the doc--improve-readme branch March 27, 2026 10:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant