Skip to content

docs: update readme for missing nerdydata source - #726

Open
davidbielik wants to merge 3 commits into
projectdiscovery:mainfrom
nerdydata:feature/nerdydata
Open

docs: update readme for missing nerdydata source#726
davidbielik wants to merge 3 commits into
projectdiscovery:mainfrom
nerdydata:feature/nerdydata

Conversation

@davidbielik

@davidbielik davidbielik commented Apr 27, 2026

Copy link
Copy Markdown
Contributor
  • Documentation update:
    • Added -nd, -nerdydata flag to the search engine options in README.md to indicate support for NerdyData queries.

Summary by CodeRabbit

  • Documentation
    • Added NerdyData as a selectable search engine in the help text.
    • Documented a new per-engine query flag (-nd, -nerdydata) for NerdyData.
    • Adjusted spacing/indentation for the Google query flag (-gg) for consistent alignment.
    • Clarified README help text around search-engine options for improved usability.

Review Change Stack

@neo-by-projectdiscovery-dev

neo-by-projectdiscovery-dev Bot commented Apr 27, 2026

Copy link
Copy Markdown

Neo - PR Security Review

No security issues found

Comment @pdneo help for available commands. · Open in Neo

@coderabbitai

coderabbitai Bot commented Apr 27, 2026

Copy link
Copy Markdown
Contributor

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: 4888643c-9cb8-43b9-836e-c604d80e46b1

📥 Commits

Reviewing files that changed from the base of the PR and between 09b7e76 and 39f4fe9.

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

Walkthrough

The README.md help text now includes nerdydata in the -e, -engine list and adds a per-engine flag -nd, -nerdydata under SEARCH-ENGINE; the -gg, -google flag line spacing was adjusted for alignment.

Changes

Documentation

Layer / File(s) Summary
Add nerdydata engine and flag
README.md
-e, -engine list now includes nerdydata; added -nd, -nerdydata SEARCH-ENGINE flag and adjusted spacing for -gg, -google.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A tiny flag hops into view,
NerdyData joins the engine crew,
Dashes aligned, the help looks neat,
README trimmed and tidy, sweet,
Hooray — documentation anew!

🚥 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 describes the main change: updating the README to document the nerdydata search engine source, which aligns with the changeset.
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

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

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`:
- Line 93: Update README to fully document the NerdyData integration end-to-end:
add the -nd, -nerdydata flag to all command/flags tables and examples, include
"nerdydata" as an option in the -e, -engine list/description (referencing the
-e, -engine flag and the -nd, -nerdydata flag), and add a new subsection in the
configuration/API-key section describing how to obtain and set the NerdyData API
key (include the env var or config field name used by the codebase and an
example of usage in commands/examples that use -nd). Ensure the docs contain a
brief example command showing -nd with a sample query file and a note about
where to place the API key so users can configure it end-to-end.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2e3c1697-b961-4920-8fc2-4f2ee7962d28

📥 Commits

Reviewing files that changed from the base of the PR and between 92e6147 and 5ac3c55.

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

Comment thread README.md
@davidbielik davidbielik changed the title [Docs] update readme for missing nerdydata source docs: update readme for missing nerdydata source May 1, 2026

@ehsandeep ehsandeep left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Image

@davidbielik
davidbielik requested a review from ehsandeep May 20, 2026 13:48
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.

2 participants