Skip to content

Commit e594641

Browse files
aciddjusocvitOvi
committed
Fix grammar and update account example
Co-Authored-By: Dmytro Horoshko <13473505+ocvit@users.noreply.github.com> Co-Authored-By: Muhammad Ovi (Owais) <contact@muhammadovi.com>
1 parent 474cdbb commit e594641

1 file changed

Lines changed: 21 additions & 23 deletions

File tree

README.md

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Integrate search data into your AI workflow, RAG / fine-tuning, or Ruby applicat
66

77
SerpApi supports Google, Google Maps, Google Shopping, Baidu, Yandex, Yahoo, eBay, App Stores, and [more](https://serpapi.com).
88

9-
Fast query at scale a vast range of data, including web search results, flight schedules, stock market data, news headlines, and [more](https://serpapi.com).
9+
Query a vast range of data at scale, including web search results, flight schedules, stock market data, news headlines, and [more](https://serpapi.com).
1010

1111
## Features
1212
* `persistent` → Keep socket connection open to save on SSL handshake / reconnection (2x faster). [Search at scale](#Search-At-Scale)
@@ -16,10 +16,9 @@ Fast query at scale a vast range of data, including web search results, flight s
1616

1717
## Installation
1818

19-
To achieve optimal performance, you should have the latest Ruby version installed on your system (Ruby 2.7+ is supported, but 3.4 is recommended for [performance reason](#Performance-Comparison)).
20-
21-
| Older versions such as Ruby 1.9, 2.x, and JRuby are compatible with [serpapi older library](https://github.com/serpapi/google-search-results-ruby), which continues to function effectively. see [migration guide](#Migration-quick-guide) if you are using the older library.
19+
Ruby 2.7 and later are supported. To achieve an optimal performance, the latest version is recommended. Check 2.7.8 vs 3.4.4 [performance comparison](#Performance-Comparison).
2220

21+
Other versions, such as Ruby 1.9, Ruby 2.x, and JRuby, are compatible with [legacy SerpApi library](https://github.com/serpapi/google-search-results-ruby), which is still supported. To upgrade to the latest library, check our [migration guide](#Migration-quick-guide).
2322

2423
### Bundler
2524
```ruby
@@ -55,7 +54,7 @@ Environment variables are a secure, safe, and easy way to manage secrets.
5554
## Search API advanced usage with Google search engine
5655

5756
This example dives into all the available parameters for the Google search engine.
58-
The set of parameters is extensive and depends on your chosen search engine.
57+
The list of parameters depends on the chosen search engine.
5958

6059
```ruby
6160
# load gem
@@ -163,8 +162,7 @@ puts 'done'
163162

164163
* source code: [demo/demo_async.rb](https://github.com/serpapi/serpapi-ruby/blob/master/demo/demo_async.rb)
165164

166-
This code shows a simple solution to batch searches asynchronously into a [queue](https://en.wikipedia.org/wiki/Queue_(abstract_data_type)).
167-
Each search takes a few seconds before completion by SerpApi service and the search engine. By the time the first element pops out of the queue. The search result might already be available in the archive. If not, the `search_archive` method blocks until the search results are available.
165+
This code shows a simple solution to batch searches asynchronously into a [queue](https://en.wikipedia.org/wiki/Queue_(abstract_data_type)). Each search may take up to few seconds to complete. By the time the first element pops out of the queue, the search results might already be available in the archive. If not, the `search_archive` method blocks until the search results are available.
168166

169167
### Search at scale
170168
The provided code snippet is a Ruby spec test case that demonstrates the use of thread pools to execute multiple HTTP requests concurrently.
@@ -300,22 +298,22 @@ pp client.account
300298
It prints your account information as:
301299
```ruby
302300
{
303-
account_id: "1234567890",
304-
api_key: "your_secret_key",
305-
account_email: "email@company.com",
306-
account_status: "Active",
307-
plan_id: "free",
308-
plan_name: "Free Plan",
309-
plan_monthly_price: 0.0,
310-
searches_per_month: 100,
311-
plan_searches_left: 0,
312-
extra_credits: 100,
313-
total_searches_left: 10,
314-
this_month_usage: 100,
315-
this_hour_searches: 0,
316-
last_hour_searches: 0,
317-
account_rate_limit_per_hour: 100
318-
}
301+
account_id: "1234567890",
302+
api_key: "your_secret_key",
303+
account_email: "email@company.com",
304+
account_status: "Active",
305+
plan_id: "free",
306+
plan_name: "Free Plan",
307+
plan_monthly_price: 0.0,
308+
searches_per_month: 250,
309+
plan_searches_left: 250,
310+
extra_credits: 0,
311+
total_searches_left: 250,
312+
this_month_usage: 0,
313+
this_hour_searches: 0,
314+
last_hour_searches: 0,
315+
account_rate_limit_per_hour: 250
316+
}
319317
```
320318

321319
## Basic example per search engine

0 commit comments

Comments
 (0)