Skip to content

Commit c91d96f

Browse files
docs: UpdateReadme
1 parent bc515a6 commit c91d96f

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,17 @@ poetry add api-to-dataframe
5151
## Importing library
5252
from api_to_dataframe import ClientBuilder, RetryStrategies
5353

54-
# Create a client for the API without retry strategy and default timeout (5 seconds)
54+
# Create a client for simple ingest data from API (timeout 5 seconds)
5555
client = ClientBuilder(endpoint="https://api.example.com")
56+
5657
# if you can define timeout, use: (default is 5 seconds), with LinearStrategy (In development, actually don't nothing) and set headers:
5758
headers = {
5859
"application_name": "api_to_dataframe"
5960
}
60-
client = ClientBuilder(endpoint="https://api.example.com", retry_strategy=RetryStrategies.LinearStrategy, timeout=10, headers=headers)
61+
client = ClientBuilder(endpoint="https://api.example.com"
62+
,retry_strategy=RetryStrategies.LinearStrategy
63+
,timeout=10
64+
,headers=headers)
6165

6266
### timeout, retry_strategy and headers are opcionals parameters
6367

0 commit comments

Comments
 (0)