Skip to content

Add Used By section to README#36

Open
dogancanbakir wants to merge 1 commit intomainfrom
docs/used-by
Open

Add Used By section to README#36
dogancanbakir wants to merge 1 commit intomainfrom
docs/used-by

Conversation

@dogancanbakir
Copy link
Member

@dogancanbakir dogancanbakir commented Mar 9, 2026

Add Used By section highlighting katana and httpx.

Summary by CodeRabbit

  • Documentation
    • Added "Used By" section to README showcasing external projects leveraging this library, including descriptions and links.

@coderabbitai
Copy link

coderabbitai bot commented Mar 9, 2026

Walkthrough

A "Used By" section is added to the README, documenting two external projects that utilize the codebase. The section includes project names, brief descriptions, and reference links for each project.

Changes

Cohort / File(s) Summary
Documentation
README.md
Added new "Used By" section listing external projects (katana and httpx) with descriptions and links.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A README grows, a section so fine,
Projects now listed in neat, tidy line,
Katana and httpx shine with pride,
Their glory and links we now broadcast wide! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and accurately describes the main change: adding a 'Used By' section to the README, which matches the raw summary and PR objectives.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/used-by

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

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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Around line 148-152: Update the "Used By" section in README.md by removing the
"- [katana](https://github.com/projectdiscovery/katana) - A next-generation
crawling and spidering framework" entry and leaving only the "-
[httpx](https://github.com/projectdiscovery/httpx) - A fast and multi-purpose
HTTP toolkit" line; edit the block that currently lists "katana" and "httpx"
under the "Used By" heading to delete the katana bullet so the listed consumers
accurately reflect dependencies.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a61d92c3-65de-47d0-aff0-c4841c0cd693

📥 Commits

Reviewing files that changed from the base of the PR and between 3a0f7ca and ae55b38.

📒 Files selected for processing (1)
  • README.md

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