docs: update README usage accuracy

[CodeDeficient]

User description

Summary

• Replace fixed runtime claim with a repo-size/network-dependent statement
• Document positional path arguments and the -- separator
• Document minPackageAgeDays in the config example
• Remove stale reference to a non-existent workflow file
• Keep the npm-rendered screenshot reference

Test Plan

• Delegated commit review: clean
• Docs-only change; full test suite not run

---

CodeAnt-AI Description

Update README usage instructions and config examples

What Changed

• Clarifies that scan time can vary based on project size and package freshness checks, instead of claiming a fixed runtime
• Adds examples for scanning specific files or folders, including how to pass paths that start with a dash
• Documents optional path arguments and the -- separator in the command list
• Adds minPackageAgeDays to the config example and removes a stale reference to a workflow file

Impact

✅ Clearer setup instructions
✅ Fewer command-line usage mistakes
✅ More accurate README examples

💡 Usage Guide

Checking Your Pull Request

Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.

Talking to CodeAnt AI

Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:

@codeant-ai ask: Your question here

This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.

Example

@codeant-ai ask: Can you suggest a safer alternative to storing this secret?

Preserve Org Learnings with CodeAnt

You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:

@codeant-ai: Your feedback here

This helps CodeAnt AI learn and adapt to your team's coding style and standards.

Example

@codeant-ai: Do not flag unused imports.

Retrigger review

Ask CodeAnt AI to review the PR again, by typing:

@codeant-ai: review

Check Your Repository Health

To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.

Summary by CodeRabbit

• Documentation
  • Updated README with enhanced usage guidance for path scanning, including support for dash-prefixed paths.
  • Added -- end-of-flags separator documentation and performance notes for the --quiet flag.
  • Expanded configuration examples with minPackageAgeDays setting and adjusted CI/CD instructions.

[codeant-ai]

---

Thanks for using CodeAnt! 🎉

We're free for open-source projects. if you're enjoying it, help us grow by sharing.

Share on X ·
Reddit ·
LinkedIn

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 72c49a27-45f9-4fbb-90fc-5dd563f43317

📥 Commits

Reviewing files that changed from the base of the PR and between c7d1b15 and 2f058ac.

📒 Files selected for processing (1)

• README.md

---

📝 Walkthrough

Walkthrough

README.md is updated with a runtime caveat for the --quiet scan note, expanded usage instructions for scanning specific paths and dash-prefixed paths, the -- end-of-flags separator added to the CLI options list, minPackageAgeDays: 7 added to the config example, and the reference to an external GitHub Actions workflow file removed.

Changes

README Documentation Update

Layer / File(s)	Summary
Usage, options, config, and CI/CD docs README.md	Rewrites the quick-scan runtime note; adds path-scanning and -- separator guidance to the Usage section; adds -- to the CLI options list; adds minPackageAgeDays: 7 to the config JSON sample; removes the stale pointer to .github/workflows/karpeslop.yml.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 Hop hop, the docs grow clear,
Paths with dashes — no more fear!
-- to the rescue, flags at bay,
minPackageAgeDays joins the fray.
README sparkles, fresh today! ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately reflects the main objective of the PR, which is updating README documentation for accuracy.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/readme-accuracy

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}