docs: update and enhance README

[dylanpulver]

Summary by CodeRabbit

• Documentation
  • Restructured the README.md for improved clarity and organization.
  • Added a new "Getting Started with Safety CLI" section for new users.
  • Enhanced command breakdowns with clearer installation and usage instructions.
  • Condensed the "Key Features" section to better highlight functionalities and CI/CD integration.
  • Clarified licensing and supported Python versions for better user understanding.

[coderabbitai]

Walkthrough

The changes to the README.md for the Safety CLI project significantly enhance its structure and clarity. The document now provides a more focused introduction, reorganized navigation, and streamlined command descriptions, all aimed at improving user experience. Key features are highlighted more effectively, and essential information for new users is consolidated, ensuring that the document better serves its audience in understanding and utilizing the vulnerability scanner.

Changes

File	Change Summary
README.md	Restructured content for clarity, improved navigation with a new "Getting Started" section, enhanced command descriptions, and a condensed "Key Features" section. Clarified licensing and compatibility information.

Poem

In the garden of code, where the rabbit does hop,
Safety CLI blooms, making vulnerabilities stop.
With a hop and a skip, it guides you with glee,
Securing your projects, as safe as can be! 🐰✨
So gather your tools, let the scanning begin,
For a safer tomorrow, let the fun now begin! 🎉

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d380000 and 526fd08.

Files selected for processing (1)

• README.md (2 hunks)

Additional context used

LanguageTool

README.md

[grammar] ~58-~58: The word ‘help’ is a conjunction. In formal texts, use “to”.
Context: ...Commands - safety --help: Access help and display all available commands. - `safe...

(HELP_AND_VB)

---

[uncategorized] ~59-~59: Loose punctuation mark.
Context: ... all available commands. - safety auth: Start authentication flow or display st...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~60-~60: Loose punctuation mark.
Context: ... flow or display status. - safety scan: Perform a vulnerability scan in the cur...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~61-~61: Loose punctuation mark.
Context: ...directory. - safety scan --apply-fixes: Update vulnerable dependencies for requ...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~121-~121: Possible missing comma found.
Context: ...ety CLI on versions <3.7 using a Docker image are available in our Documentation Hub....

(AI_HYDRA_LEO_MISSING_COMMA)