Skip to content

Commit 3a6137d

Browse files
Fix capitalization in README
Updated headings and section titles for consistency and clarity.
1 parent 21ac067 commit 3a6137d

1 file changed

Lines changed: 11 additions & 12 deletions

File tree

‎README.md‎

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
<div align="center">
2-
<h1 align="center">SerpApi C++ Library</h1>
1+
# SerpApi C++ Library
32

43
[![SerpApi C++](https://github.com/serpapi/serpapi-cpp/actions/workflows/ci.yml/badge.svg)](https://github.com/serpapi/serpapi-cpp/actions/workflows/ci.yml)
5-
</div>
64

75
Integrate search data into your C++ application. This library is the official wrapper for [SerpApi](https://serpapi.com).
86

@@ -22,7 +20,7 @@ brew install rapidjson
2220
sudo apt update && sudo apt install -y rapidjson-dev
2321
```
2422

25-
### Installation from Release
23+
### Installation
2624

2725
Download and extract the latest release:
2826

@@ -36,7 +34,7 @@ sudo meson install -C build
3634

3735
Tests are disabled by default for release builds. To build and run tests with Meson, install GoogleTest and configure with `-Dtests=true`.
3836

39-
### Meson Dependency
37+
### Meson dependency
4038

4139
Add the dependency to your `meson.build`:
4240

@@ -53,7 +51,7 @@ serpapi_dep = serpapi_proj.get_variable('libserpapi_dep')
5351

5452
[SerpApi C++](https://github.com/serpapi/serpapi-cpp)
5553

56-
## Simple Usage
54+
## Quick start
5755

5856
```cpp
5957
#include <iostream>
@@ -91,7 +89,7 @@ int main() {
9189

9290
This example runs a search for "coffee" on Google. It then returns the results as a RapidJSON Document. See the [playground](https://serpapi.com/playground) to generate your own code, or check out our [local examples](example/).
9391

94-
## Advanced Usage
92+
## Advanced usage
9593
### Search API
9694
```cpp
9795
#include <serpapi.hpp>
@@ -180,7 +178,7 @@ Search API features non-blocking search using the option: `async=true`.
180178
- Non-blocking - async=true - a single parent process can handle unlimited concurrent searches.
181179
- Blocking - async=false - processes must wait for the HTTP response.
182180

183-
### Example: Asynchronous searches
181+
### Asynchronous searches example
184182

185183
```cpp
186184
#include <serpapi.hpp>
@@ -203,20 +201,21 @@ int main() {
203201
}
204202
```
205203

206-
## Supported C++ version.
204+
## Supported C++ versions
205+
207206
C++ versions validated by Github Actions:
208207
- C++17
209208
- C++20
210209

211-
## Change logs
210+
## Change log
212211
* [2026-08-16] 0.5.0 Add markdown() support via the output=md format.
213212
* [2026-06-26] 0.4.1 Exclude test dependencies from release build.
214213
* [2026-06-08] 0.4.0 Add unit tests and improve error handling.
215214
* [2026-02-12] 0.3.0 Refactor and cleanup.
216215
* [2026-01-06] 0.2.0 Release package with meson build system.
217216
* [2023-02-20] 0.1.0 Full API support
218217

219-
## Developer Guide
218+
## Developer guide
220219
### Key goals
221220
- Brand centric instead of search engine based
222221
- Simple HTTP client (lightweight, reduced dependency)
@@ -245,7 +244,7 @@ Generated with `rake coverage` (requires `SERPAPI_KEY` set to exercise the live
245244
- functions: 100.0% (15/15)
246245
- branches: 45.9% (79/172)
247246

248-
## Design : UML diagram
247+
## Design: UML diagram
249248
### Class diagram
250249
```mermaid
251250
classDiagram

0 commit comments

Comments
 (0)