Skip to content

Update README.md #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
contributor860 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README.md #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc06390
Update README.md
contributor860 Aug 26, 2026
fc2b9ba
docs: maintain README.md by hand and drop README.md.erb
jvmvik Nov 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,7 @@ export SERPAPI_KEY='your_key' # optional: without it, many tests skip; some te
./gradlew test
```

Regenerate README.md from the template after editing examples:

```bash
make readme # requires Ruby `erb`
```
README.md is maintained by hand. When you change an example under `src/test/java/serpapi/example/`, update its snippet in README.md too.

How to build from source
Clone the repository:
Expand Down
6 changes: 1 addition & 5 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.PHONY: build

all: clean init build test readme doc
all: clean init build test doc

# clean
clean:
Expand Down Expand Up @@ -29,10 +29,6 @@ build: clean
oobt: build
$(MAKE) -C demo all

# Ruby must be installed (ERB is located under $GEM_HOME/bin or under Ruby installation)
readme:
erb -T '-' README.md.erb > README.md

# Build the javadoc
doc:
./gradlew javadoc --warning-mode all
Expand Down
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ dependencies {
To list all available versions see:
https://jitpack.io/api/builds/com.github.serpapi/serpapi-java

or you can download the jar file from https://github.com/serpapi/serpapi-java/releases.
Or you can download the JAR file from https://github.com/serpapi/serpapi-java/releases.

_Note: JitPack builds Maven artifacts from GitHub releases and tags._

Expand Down Expand Up @@ -598,15 +598,15 @@ SerpApi is served over **HTTPS (TLS)**. Very old JRE/JDK builds may lack the TLS

### Solution

Use a **current JDK** (this project is tested on **JDK 21**). On macOS you can select an installed JDK, for example:
Use a **current JDK** (this project is tested on **JDK 21**). On macOS, you can select an installed JDK, for example:

```sh
/usr/libexec/java_home -V
export JAVA_HOME=$(/usr/libexec/java_home -v 21)
java -version
```

On Windows, install a current JDK from your vendor and point `JAVA_HOME` at it.
On Windows, install a current JDK from your vendor and point `JAVA_HOME` to it.

## Contributing

Expand Down
Loading
Loading