anikeen/id
1
0
Fork 0
mirror of https://github.com/anikeen-com/id.git synced 2026-03-13 13:46:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

update docs

Browse Source 
Signed-off-by: Maurice Preuß (envoyr) <hello@envoyr.com>
This commit is contained in:
Maurice Preuß (envoyr)
2025-04-28 05:32:44 +02:00
parent 1b96b87e1d
commit 21946e3a22
2 changed files with 42 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@@ -9,12 +9,11 @@ PHP Anikeen ID API Client for Laravel 11+
## Table of contents ## Table of contents
1. [Installation](#installation) 1. [Installation](#installation)
2. [Event Listener](#event-listener) 2. [Configuration](#configuration)
3. [Configuration](#configuration) 3. [General](#general)
4. [General](#general) 4. [Examples](#examples)
5. [Examples](#examples) 5. [Documentation](#documentation)
6. [Documentation](#documentation) 6. [Development](#Development)
7. [Development](#Development)
## Installation ## Installation
@@ -22,19 +21,9 @@ PHP Anikeen ID API Client for Laravel 11+
composer require anikeen/id composer require anikeen/id
``` ```
## Event Listener
In Laravel 11, the default EventServiceProvider provider was removed. Instead, add the listener using the listen method on the Event facade, in your `AppServiceProvider`
```
Event::listen(function (\SocialiteProviders\Manager\SocialiteWasCalled $event) {
$event->extendSocialite('anikeen-id', \Anikeen\Id\Socialite\Provider::class);
});
```
## Configuration ## Configuration
Add environmental variables to your `.env` Add environmental variables to your `.env` file:
``` ```
ANIKEEN_ID_KEY= ANIKEEN_ID_KEY=
@@ -44,7 +33,7 @@ ANIKEEN_ID_CALLBACK_URL=http://localhost/auth/callback
You will need to add an entry to the services configuration file so that after config files are cached for usage in production environment (Laravel command `artisan config:cache`) all config is still available. You will need to add an entry to the services configuration file so that after config files are cached for usage in production environment (Laravel command `artisan config:cache`) all config is still available.
**Add to `config/services.php`:** Add to `config/services.php` file:
```php ```php
'anikeen' => [ 'anikeen' => [
@@ -55,6 +44,19 @@ You will need to add an entry to the services configuration file so that after c
], ],
``` ```
### Event Listener
In Laravel 11, the default EventServiceProvider provider was removed. Instead, add the listener using the listen method on the Event facade, in your `AppServiceProvider` boot method:
```php
public function boot(): void
{
Event::listen(function (\SocialiteProviders\Manager\SocialiteWasCalled $event) {
$event->extendSocialite('anikeen-id', \Anikeen\Id\Socialite\Provider::class);
});
}
```
### Registering Middleware ### Registering Middleware
Append it to the global middleware stack in your application's `bootstrap/app.php` file: Append it to the global middleware stack in your application's `bootstrap/app.php` file:
@@ -86,7 +88,7 @@ then, you can use the `Billable` trait methods in your user model.
### Change the default access token / refresh token field name ### Change the default access token / refresh token field name
If you access / refresh token fields differs from the default `anikeen_id_access_token` / `anikeen_id_refresh_token`, you can specify the field name in the 'AppServiceProvider' boot method: If you access / refresh token fields differs from the default `anikeen_id_access_token` / `anikeen_id_refresh_token`, you can specify the field name in the `AppServiceProvider` boot method:
```php ```php
use Anikeen\Id\AnikeenId; use Anikeen\Id\AnikeenId;

40
README.stub
View File

@@ -9,12 +9,11 @@ PHP Anikeen ID API Client for Laravel 11+
## Table of contents ## Table of contents
1. [Installation](#installation) 1. [Installation](#installation)
2. [Event Listener](#event-listener) 2. [Configuration](#configuration)
3. [Configuration](#configuration) 3. [General](#general)
4. [General](#general) 4. [Examples](#examples)
5. [Examples](#examples) 5. [Documentation](#documentation)
6. [Documentation](#documentation) 6. [Development](#Development)
7. [Development](#Development)
## Installation ## Installation
@@ -22,19 +21,9 @@ PHP Anikeen ID API Client for Laravel 11+
composer require anikeen/id composer require anikeen/id
``` ```
## Event Listener
In Laravel 11, the default EventServiceProvider provider was removed. Instead, add the listener using the listen method on the Event facade, in your `AppServiceProvider`
```
Event::listen(function (\SocialiteProviders\Manager\SocialiteWasCalled $event) {
$event->extendSocialite('anikeen-id', \Anikeen\Id\Socialite\Provider::class);
});
```
## Configuration ## Configuration
Add environmental variables to your `.env` Add environmental variables to your `.env` file:
``` ```
ANIKEEN_ID_KEY= ANIKEEN_ID_KEY=
@@ -44,7 +33,7 @@ ANIKEEN_ID_CALLBACK_URL=http://localhost/auth/callback
You will need to add an entry to the services configuration file so that after config files are cached for usage in production environment (Laravel command `artisan config:cache`) all config is still available. You will need to add an entry to the services configuration file so that after config files are cached for usage in production environment (Laravel command `artisan config:cache`) all config is still available.
**Add to `config/services.php`:** Add to `config/services.php` file:
```php ```php
'anikeen' => [ 'anikeen' => [
@@ -55,6 +44,19 @@ You will need to add an entry to the services configuration file so that after c
], ],
``` ```
### Event Listener
In Laravel 11, the default EventServiceProvider provider was removed. Instead, add the listener using the listen method on the Event facade, in your `AppServiceProvider` boot method:
```php
public function boot(): void
{
Event::listen(function (\SocialiteProviders\Manager\SocialiteWasCalled $event) {
$event->extendSocialite('anikeen-id', \Anikeen\Id\Socialite\Provider::class);
});
}
```
### Registering Middleware ### Registering Middleware
Append it to the global middleware stack in your application's `bootstrap/app.php` file: Append it to the global middleware stack in your application's `bootstrap/app.php` file:
@@ -86,7 +88,7 @@ then, you can use the `Billable` trait methods in your user model.
### Change the default access token / refresh token field name ### Change the default access token / refresh token field name
If you access / refresh token fields differs from the default `anikeen_id_access_token` / `anikeen_id_refresh_token`, you can specify the field name in the 'AppServiceProvider' boot method: If you access / refresh token fields differs from the default `anikeen_id_access_token` / `anikeen_id_refresh_token`, you can specify the field name in the `AppServiceProvider` boot method:
```php ```php
use Anikeen\Id\AnikeenId; use Anikeen\Id\AnikeenId;