Skip to content

Java README Integration Guide Additions - #11

Open
audrey-serpapi wants to merge 5 commits into
masterfrom
readme-doc-update
Open

Java README Integration Guide Additions#11
audrey-serpapi wants to merge 5 commits into
masterfrom
readme-doc-update

Conversation

@audrey-serpapi

Copy link
Copy Markdown

@audrey-serpapi audrey-serpapi self-assigned this Sep 8, 2026
Comment thread README.md

Using Maven / Gradle.

Edit your `build.gradle` file:

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I feel like we should start earlier. Here, we're assuming people already have "build.gradle" file. Can we start somewhere, like creating a new folder, then ....

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Comment thread README.md
cd serpapi-java/demo
make all SERPAPI_KEY='<your private key>'
```
Use quotes if your key contains shell-special characters. You need a SerpApi account to obtain a key: https://serpapi.com/dashboard

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

"You need a SerpApi account to obtain a key: https://serpapi.com/dashboard"

Duplication. We already mention it after the quickstart

Comment thread README.md
The [SerpApi.com API Documentation](https://serpapi.com/search-api) contains a list of all the possible parameters that can be passed to the API.
## Features

- [Asynchronous searches](https://github.com/serpapi/serpapi-java/commit/75417ff5fe603d19c0a30933251d4bb469ddfe9b) for submitting non-blocking jobs and retrieving completed results from the Search Archive API

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Why do we link it to a commit?

Comment thread README.md
parameter.put("p", "coffee");
JsonObject results = client.search(parameter);
System.out.println(results.toString());
System.out.println("waiting 10s for searches to complete...");

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Maybe we should add a comment that this is a simulation. In real life, people may need to check process status instead of waiting for a specific time.

@hilmanski

Copy link
Copy Markdown

Any reasons we're dropping these sections:

  • Migrations from the old library
  • TLS / HTTPS and older JVMs

Please also create a summary of your PR changes in the description

CleanShot 2026-09-09 at 13 59 01

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