Skip to content

Commit 90beade

Browse files
authored
Update README.md
1 parent ef6ea86 commit 90beade

File tree

1 file changed

+6
-12
lines changed

1 file changed

+6
-12
lines changed

README.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,12 @@ A convenient API wrapper for the Odds API, designed for Composer environments su
1010
## About "The Odds API"
1111
[The Odds API](https://the-odds-api.com/) is a simple and very well-documented API, allowing for fast, low-cost integration. It covers over 70 sports and over 40 bookmakers - with a continuing expanding offering. The Odds API is an Australian company based in Melbourne since 2017.
1212

13-
## So why make a wrapper
14-
A wrapper simplifies the usage and implementation of powerful APIs like "The Odds API" It abstracts the complexities of direct API interactions, providing a more user-friendly interface for us developers.
13+
## Why a Wrapper?
14+
A wrapper simplifies the usage and implementation of powerful APIs like "The Odds API". It abstracts the complexities of direct API interactions, providing a more user-friendly interface for us developers.
1515

1616
# Contribution Guide
1717
This is an open-source project, so contributions are welcome! Whether you want to add new features, fix bugs, or improve documentation, your help is appreciated. Submit your PR for review and I will review them as soon as possible.
1818

19-
**Sport Enum opportunity**
20-
This package uses an enum to define the sports you can pass to the endpoints, this ensures you don't make a typo or have
21-
to worry about remembering the exact grammar. Currently, there are only a couple sports so if you need the support for more,
22-
make a PR to add them in.
23-
2419
# Steps for Installation
2520
### Composer
2621
```bash
@@ -34,12 +29,11 @@ php artisan vendor:publish --tag="odds-api-config"
3429
```
3530

3631
### Example Usages
37-
You can simply create a new Client, passing in your api key and that's it! You can decide to bind the class in
38-
your `AppServiceProvider`, but if not, the client can easily be initialised in any `__invoke` or `__construct`
32+
You can simply create a new Client, passing in your api key and that's it!
3933
```php
4034
$client = new OddsClient(config('odds-api.api_key'));
4135

42-
$response = $client->setRegion('us')
36+
$response = $client->setRegion('au')
4337
->dateFormat('iso')
4438
->getOddsForSport(SportsEnum::RUGBYLEAGUE_NRL);
4539

@@ -86,8 +80,8 @@ This avoids having to define these on each request, but they can be overwritten
8680
To help manage your quota, there are helpers that you can call to return the number of requests used and remaining. Checkout the `UseHandleHeaders` trait, which
8781
can be called on any `OddsClient` instant.
8882

89-
Also, if this API ever becomes outdated for a small period of time, and you require to use new parameters, you can utilise
90-
the `addParams()` function, which accepts an array where you can pass any new parameters.
83+
Also, if this API ever becomes outdated for a small period of time and you need to add new parameters, you can utilise
84+
the `addParams()` function, which accepts an array.
9185

9286
## Credits
9387
- [Seth Sharp](https://github.com/SethSharp)

0 commit comments

Comments
 (0)