docs: updated base configuration, resource methods and other improvem…

…ents
programmatordev · May 16, 2024 · b0c0ca4 · b0c0ca4
1 parent fb4af91
commit b0c0ca4
Show file tree

Hide file tree

Showing 7 changed files with 259 additions and 407 deletions.
diff --git a/README.md b/README.md
@@ -19,35 +19,24 @@ You must sign up for a [SportMonks account](https://www.sportmonks.com/football-
 
 ## Installation
 
-You can install the library via [Composer](https://getcomposer.org/):
+Install the library via [Composer](https://getcomposer.org/):
 
 ```bash
 composer require programmatordev/sportmonksfootball-php-api
 ```
 
-To use the library, use Composer's [autoload](https://getcomposer.org/doc/01-basic-usage.md#autoloading):
-
-```php
-require_once 'vendor/autoload.php';
-```
-
 ## Basic Usage
 
 Simple usage looks like:
 
 ```php
-use ProgrammatorDev\SportMonksFootball\Config;
 use ProgrammatorDev\SportMonksFootball\SportMonksFootball;
 
-// Initialize
-$sportMonksFootball = new SportMonksFootball(
-    new Config([
-        'applicationKey' => 'yourappkey'
-    ])
-);
+// initialize
+$api = new SportMonksFootball('yourapikey');
 
-// Get all livescores of the current day
-$livescores = $sportMonksFootball->livescores()->getAll();
+// get all livescores of the current day
+$livescores = $api->livescores()->getAll();
 ```
 
 ## Documentation
@@ -59,7 +48,7 @@ $livescores = $sportMonksFootball->livescores()->getAll();
   - [Odds](docs/03-supported-endpoints.md#odds-endpoints)
   - [Core](docs/03-supported-endpoints.md#core-endpoints)
 - [Error Handling](docs/04-error-handling.md)
-- [Objects](docs/05-objects.md)
+- [Entities](docs/05-entities.md)
 
 ## Contributing
 

diff --git a/docs/01-usage.md b/docs/01-usage.md
@@ -16,33 +16,22 @@ You must sign up for a [SportMonks account](https://www.sportmonks.com/football-
 
 ## Installation
 
-You can install the library via [Composer](https://getcomposer.org/):
+Install the library via [Composer](https://getcomposer.org/):
 
 ```bash
 composer require programmatordev/sportmonksfootball-php-api
 ```
 
-To use the library, use Composer's [autoload](https://getcomposer.org/doc/01-basic-usage.md#autoloading):
-
-```php
-require_once 'vendor/autoload.php';
-```
-
 ## Basic Usage
 
 Simple usage looks like:
 
 ```php
-use ProgrammatorDev\SportMonksFootball\Config;
 use ProgrammatorDev\SportMonksFootball\SportMonksFootball;
 
-// Initialize
-$sportMonksFootball = new SportMonksFootball(
-    new Config([
-        'applicationKey' => 'yourappkey'
-    ])
-);
+// initialize
+$api = new SportMonksFootball('yourapikey');
 
-// Get all livescores of the current day
-$livescores = $sportMonksFootball->livescores()->getAll();
+// get all livescores of the current day
+$livescores = $api->livescores()->getAll();
 ```