Restructure README - #26
Open
strzibny wants to merge 2 commits into
Open
Conversation
trusche
requested changes
Aug 13, 2026
| * [API health status](https://serpapi.com/status) | ||
|
|
||
| ## Advanced search API usage | ||
| ### Search Asynchronous |
Member
There was a problem hiding this comment.
I think we should keep a dedicated section explaining async searches in the main README. It can be less verbose and link to the demo code ford details.
Contributor
Author
|
@trusche I restored it as-is (for now) inside configuration as I feel it's better to keep the Features section light and punchy and explain the details as part of the configuration just after the table with all the options. Wdyt? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates our READMEs to a new structure we discussed internally as part of improving our website integration pages.
What changed
I tried to limit this change to the structure changes, but there a couple other minor changes too. Here's what I am changing:
README.mdandREADME.md.erbaround Installation, Quickstart, Features, Configuration, Examples, Documentation, Performance, and Contributing../CONTRIBUTING.mdlink inREADME.mdand the full GitHub URL inREADME.md.erb.I specifically didn't really touch the language or individual sections much to keep this simpler to review.
Note: Tests are failing because I am submitting from a fork.