diff --git a/README.md b/README.md index 9810ace..554177e 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,19 @@ You can install the package via `composer require`: ```bash composer require asciisd/zoho-v3 ``` -After installing the package you can publish the config file with: + +### Register Service Provider + +If the package is not auto-discovered, add the service provider in `config/app.php`: + +```php +'providers' => [ + // ...existing providers... + Asciisd\Zoho\ZohoServiceProvider::class, +], +``` + +After registering the provider, you can publish the config file with: ```bash php artisan vendor:publish --tag="zoho-v3-config" @@ -79,6 +91,15 @@ php artisan vendor:publish --tag="zoho-v3-migrations" php artisan migrate ``` + +### Routes + +Package automatically registers the following route for Zoho OAuth2 callback handling: + +```php +Route::get('zoho/oauth2callback', [\Asciisd\Zoho\Http\Controllers\ZohoController::class, 'oauth2callback']); +``` + ### Environments maybe in some cases you wish to enforce zoho to use one of zoho's environments, so you can go to `AppServiceProvider` and use `Zoho::useEnvironment()` method