docs: updated config and geocoding resource

Author: andrepimpao

README.md

@@ -19,37 +19,26 @@ You must sign up for an [OpenWeatherMap account](https://openweathermap.org/appi
 
 ## Installation
 
-You can install the library via [Composer](https://getcomposer.org/):
+Install the library via [Composer](https://getcomposer.org/):
 
 ```bash
 composer require programmatordev/openweathermap-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\OpenWeatherMap\Config;
 use ProgrammatorDev\OpenWeatherMap\OpenWeatherMap;
 
-// Initialize
-$openWeatherMap = new OpenWeatherMap(
-    new Config([
-        'applicationKey' => 'yourappkey'
-    ])
-);
-
-// Get current weather by coordinate (latitude, longitude)
-$currentWeather = $openWeatherMap->weather()->getCurrent(50, 50);
-// Show current temperature
-echo $currentWeather->getTemperature();
+// initialize
+$api = new OpenWeatherMap('yourapikey');
+
+// get current weather by coordinate (latitude, longitude)
+$weather = $api->weather()->getCurrent(50, 50);
+// show current temperature
+echo $weather->getTemperature();
 ```
 
 ## Documentation
@@ -58,7 +47,7 @@ echo $currentWeather->getTemperature();
 - [Configuration](docs/02-configuration.md)
 - [Supported APIs](docs/03-supported-apis.md)
 - [Error Handling](docs/04-error-handling.md)
-- [Objects](docs/05-objects.md)
+- [Entities](docs/05-entities)
 
 ## Contributing
 

docs/01-usage.md

@@ -16,35 +16,24 @@ You must sign up for an [OpenWeatherMap account](https://openweathermap.org/appi
 
 ## Installation
 
-You can install the library via [Composer](https://getcomposer.org/):
+Install the library via [Composer](https://getcomposer.org/):
 
 ```bash
 composer require programmatordev/openweathermap-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\OpenWeatherMap\Config;
 use ProgrammatorDev\OpenWeatherMap\OpenWeatherMap;
 
-// Initialize
-$openWeatherMap = new OpenWeatherMap(
-    new Config([
-        'applicationKey' => 'yourappkey'
-    ])
-);
-
-// Get current weather by coordinate (latitude, longitude)
-$currentWeather = $openWeatherMap->weather()->getCurrent(50, 50);
-// Show current temperature
-echo $currentWeather->getTemperature();
+// initialize
+$api = new OpenWeatherMap('yourapikey');
+
+// get current weather by coordinate (latitude, longitude)
+$weather = $api->weather()->getCurrent(50, 50);
+// show current temperature
+echo $weather->getTemperature();
 ```

docs/02-configuration.md

@@ -2,62 +2,38 @@
 
 - [Default Configuration](#default-configuration)
 - [Options](#options)
-  - [applicationKey](#applicationkey)
   - [unitSystem](#unitsystem)
   - [language](#language)
-  - [httpClientBuilder](#httpclientbuilder)
-  - [cache](#cache)
-  - [logger](#logger)
-- [Config Object](#config-object)
 
 ## Default Configuration
 
-Only the `applicationKey` option is required:
-
 ```php
-use ProgrammatorDev\OpenWeatherMap\Config;
-use ProgrammatorDev\OpenWeatherMap\HttpClient\HttpClientBuilder;
 use ProgrammatorDev\OpenWeatherMap\OpenWeatherMap;
 
-$openWeatherMap = new OpenWeatherMap(
-    new Config([
-        'applicationKey' => 'yourappkey', // required
-        'unitSystem' => 'metric',
-        'language' => 'en',
-        'httpClientBuilder' => new HttpClientBuilder(),
-        'cache' => null,
-        'logger' => null
-    ])
-);
+$api = new OpenWeatherMap('yourapikey', [
+    'unitSystem' => 'metric',
+    'language' => 'en'
+]);
 ```
 
 ## Options
 
-### `applicationKey`
-
-Required for all requests. Check the [API Key](01-usage.md#api-key) section for more information.
-
 ### `unitSystem`
 
 Unit system used when retrieving data.
 Affects temperature and speed values.
 
 Available options are `metric`, `imperial` and `standard`.
-Pre-defined [constants](../src/UnitSystem/UnitSystem.php) are also available.
 
 Example:
 
 ```php
-use ProgrammatorDev\OpenWeatherMap\Config;
 use ProgrammatorDev\OpenWeatherMap\UnitSystem\UnitSystem;
 use ProgrammatorDev\OpenWeatherMap\OpenWeatherMap;
 
-$openWeatherMap = new OpenWeatherMap(
-    new Config([
-        'applicationKey' => 'yourappkey',
-        'unitSystem' => UnitSystem::IMPERIAL
-    ])
-);
+$api = new OpenWeatherMap('yourapikey',
+    'unitSystem' => UnitSystem::IMPERIAL
+]);
 ```
 
 ### `language`
@@ -66,21 +42,16 @@ Language used when retrieving data.
 It seems to only affect weather conditions descriptions.
 
 List of all available languages can be found [here](https://openweathermap.org/api/one-call-3#multi).
-Pre-defined [constants](../src/Language/Language.php) are also available.
 
 Example:
 
 ```php
-use ProgrammatorDev\OpenWeatherMap\Config;
 use ProgrammatorDev\OpenWeatherMap\Language\Language;
 use ProgrammatorDev\OpenWeatherMap\OpenWeatherMap;
 
-$openWeatherMap = new OpenWeatherMap(
-    new Config([
-        'applicationKey' => 'yourappkey',
-        'language' => Language::PORTUGUESE
-    ])
-);
+$api = new OpenWeatherMap('yourapikey',
+    'language' => Language::PORTUGUESE
+]);
 ```
 
 ### `httpClientBuilder`
@@ -226,38 +197,4 @@ $openWeatherMap = new OpenWeatherMap(
 ```
 
 > **Note**
-> If a `cache` implementation is configured, cache events will also be logged.
-
-## Config Object
-
-Configuration getters and setters for all options are available to access and change after initialization:
-
-```php
-use ProgrammatorDev\OpenWeatherMap\Config;
-use ProgrammatorDev\OpenWeatherMap\OpenWeatherMap;
-
-$openWeatherMap = new OpenWeatherMap(
-    new Config([
-        'applicationKey' => 'yourappkey'
-    ])
-);
-
-// Using applicationKey as an example,
-// but getters and setters are available for all options
-$openWeatherMap->config()->getApplicationKey();
-$openWeatherMap->config()->setApplicationKey('newappkey');
-```
-
-Just take into account that any change will affect any subsequent request globally:
-
-```php
-// Using default 'metric' unit system
-$openWeatherMap->weather()->getCurrent(50, 50); 
-
-// Set new unit system
-$openWeatherMap->config()->setUnitSystem(UnitSystem::IMPERIAL);
-
-// Using 'imperial' unit system
-$openWeatherMap->weather()->getCurrent(50, 50);
-$openWeatherMap->weather()->getForecast(50, 50);
-```
+> If a `cache` implementation is configured, cache events will also be logged.

docs/03-supported-apis.md

@@ -14,8 +14,8 @@
     - [getHistory](#gethistory)
   - [Geocoding](#geocoding)
     - [getByLocationName](#getbylocationname)
-    - [getByZipCode](#getbyzipcode)
     - [getByCoordinate](#getbycoordinate)
+    - [getByZipCode](#getbyzipcode)
 - [Common Methods](#common-methods)
   - [withUnitSystem](#withunitsystem)
   - [withLanguage](#withlanguage)
@@ -33,7 +33,7 @@ getWeather(float $latitude, float $longitude): OneCall
 
 Get current and forecast (minutely, hourly and daily) weather data.
 
-Returns a [`OneCall`](05-objects.md#onecall) object:
+Returns a [`OneCall`](05-entities#onecall) object:
 
 ```php
 $weather = $openWeatherMap->oneCall()->getWeather(50, 50);
@@ -49,7 +49,7 @@ getHistoryMoment(float $latitude, float $longitude, \DateTimeInterface $dateTime
 
 Get weather data from a single moment in the past.
 
-Returns a [`WeatherLocation`](05-objects.md#weatherlocation) object:
+Returns a [`WeatherLocation`](05-entities#weatherlocation) object:
 
 ```php
 $weather = $openWeatherMap->oneCall()->getHistoryMoment(50, 50, new \DateTime('2023-01-01 12:00:00'));
@@ -65,7 +65,7 @@ getHistoryAggregate(float $latitude, float $longitude, \DateTimeInterface $date)
 
 Get aggregated weather data from a single day in the past.
 
-Returns a [`WeatherAggregate`](05-objects.md#weatheraggregate) object:
+Returns a [`WeatherAggregate`](05-entities#weatheraggregate) object:
 
 ```php
 $weather = $openWeatherMap->oneCall()->getHistoryAggregate(50, 50, new \DateTime('1985-07-19'));
@@ -83,7 +83,7 @@ getCurrent(float $latitude, float $longitude): WeatherLocation
 
 Get current weather data.
 
-Returns a [`WeatherLocation`](05-objects.md#weatherlocation-1) object:
+Returns a [`WeatherLocation`](05-entities#weatherlocation-1) object:
 
 ```php
 $weather = $openWeatherMap->weather()->getCurrent(50, 50);
@@ -99,7 +99,7 @@ getForecast(float $latitude, float $longitude, int $numResults = 40): WeatherLoc
 
 Get weather forecast data per 3-hour steps for the next 5 days.
 
-Returns a [`WeatherLocationList`](05-objects.md#weatherlocationlist) object:
+Returns a [`WeatherLocationList`](05-entities#weatherlocationlist) object:
 
 ```php
 // Since it returns 3-hour steps,
@@ -122,7 +122,7 @@ getCurrent(float $latitude, float $longitude): AirPollutionLocation
 
 Get current air pollution data.
 
-Returns a [`AirPollutionLocation`](05-objects.md#airpollutionlocation) object:
+Returns a [`AirPollutionLocation`](05-entities#airpollutionlocation) object:
 
 ```php
 $airPollution = $openWeatherMap->airPollution()->getCurrent(50, 50);
@@ -139,7 +139,7 @@ getForecast(float $latitude, float $longitude): AirPollutionLocationList
 
 Get air pollution forecast data per 1-hour for the next 24 hours.
 
-Returns a [`AirPollutionLocationList`](05-objects.md#airpollutionlocationlist) object:
+Returns a [`AirPollutionLocationList`](05-entities#airpollutionlocationlist) object:
 
 ```php
 $airPollutionForecast = $openWeatherMap->airPollution()->getForecast(50, 50);
@@ -159,7 +159,7 @@ getHistory(float $latitude, float $longitude, \DateTimeInterface $startDate, \Da
 
 Get air pollution history data between two dates.
 
-Returns a [`AirPollutionLocationList`](05-objects.md#airpollutionlocationlist) object:
+Returns a [`AirPollutionLocationList`](05-entities#airpollutionlocationlist) object:
 
 ```php
 $startDate = new \DateTime('-7 days'); // 7 days ago
@@ -177,62 +177,44 @@ foreach ($airPollutionHistory->getList() as $airPollution) {
 
 #### `getByLocationName`
 
+Get locations by location name. Returns an array of [`Location`](05-entities#location) entities:
+
 ```php
 /**
  * @return Location[]
  */
 getByLocationName(string $locationName, int $numResults = 5): array
 ```
 
-Get locations data by location name.
-
-Returns an array of [`Location`](05-objects.md#location) objects:
-
-```php
-$locations = $openWeatherMap->geocoding()->getByLocationName('lisbon');
-
-foreach ($locations as $location) {
-    echo $location->getName();
-    echo $location->getCountryCode();
-}
-```
-
-#### `getByZipCode`
-
-```php
-getByZipCode(string $zipCode, string $countryCode): ZipCodeLocation
-```
-
-Get location data by zip/post code.
-
-Returns a [`ZipCodeLocation`](05-objects.md#zipcodelocation) object:
-
 ```php
-$location = $openWeatherMap->geocoding()->getByZipCode('1000-001', 'pt');
-
-echo $location->getName();
+$api->geocoding()->getByLocationName('lisbon');
 ```
 
 #### `getByCoordinate`
 
+Get locations by coordinate. Returns an array of [`Location`](05-entities#location) entities:
+
 ```php
 /**
  * @return Location[]
  */
 getByCoordinate(float $latitude, float $longitude, int $numResults = 5): array
 ```
 
-Get locations data by coordinate.
+```php
+$api->geocoding()->getByCoordinate(50, 50);
+```
+
+#### `getByZipCode`
 
-Returns an array of [`Location`](05-objects.md#location) objects:
+Get location by zip code. Returns a [`Location`](05-entities#location) entity:
 
 ```php
-$locations = $openWeatherMap->geocoding()->getByCoordinate(50, 50);
+getByZipCode(string $zipCode, string $countryCode): Location
+```
 
-foreach ($locations as $location) {
-    echo $location->getName();
-    echo $location->getCountryCode();
-}
+```php
+$api->geocoding()->getByZipCode('1000-001', 'pt');
 ```
 
 ## Common Methods