diogo/indieauth
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Cleaned up usage examples

Browse Source
This commit is contained in:
Barnaby Walters 2021-06-12 23:10:20 +02:00
parent 128da7f53e
commit f28471df25
2 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -8,8 +8,14 @@ Typical minimal usage looks something like this:
```php ```php
// Somewhere in your app set-up code: // Somewhere in your app set-up code:
$server = new Taproot\IndieAuth\Server([ $server = new Taproot\IndieAuth\Server([
'secret' => APP_INDIEAUTH_SECRET, // A secret key, >= 64 characters long. // A secret key, >= 64 characters long.
'tokenStorage' => '/../data/auth_tokens/', // A path to store token data, or an object implementing TokenStorageInterface. 'secret' => APP_INDIEAUTH_SECRET,
// A path to store token data, or an object implementing TokenStorageInterface.
'tokenStorage' => '/../data/auth_tokens/',
// An authentication callback function, which either returns data about the current user,
// or redirects to/implements an authentication flow.
'handleAuthenticationRequestCallback' => function (ServerRequestInterface $request, string $authenticationRedirect, ?string $normalizedMeUrl) { 'handleAuthenticationRequestCallback' => function (ServerRequestInterface $request, string $authenticationRedirect, ?string $normalizedMeUrl) {
// If the request is authenticated, return an array with a `me` key containing the // If the request is authenticated, return an array with a `me` key containing the
// canonical URL of the currently logged-in user. // canonical URL of the currently logged-in user.

10
src/Server.php
View File

@ -31,8 +31,14 @@ use Taproot\IndieAuth\Storage\TokenStorageInterface;
* *
* // Somewhere in your app set-up code: * // Somewhere in your app set-up code:
* $server = new Taproot\IndieAuth\Server([ * $server = new Taproot\IndieAuth\Server([
* 'secret' => APP_INDIEAUTH_SECRET, // A secret key, >= 64 characters long. * // A secret key, >= 64 characters long.
* 'tokenStorage' => '/../data/auth_tokens/', // A path to store token data, or an object implementing TokenStorageInterface. * 'secret' => APP_INDIEAUTH_SECRET,
*
* // A path to store token data, or an object implementing TokenStorageInterface.
* 'tokenStorage' => '/../data/auth_tokens/',
*
* // An authentication callback function, which either returns data about the current user,
* // or redirects to/implements an authentication flow.
* 'handleAuthenticationRequestCallback' => function (ServerRequestInterface $request, string $authenticationRedirect, ?string $normalizedMeUrl) { * 'handleAuthenticationRequestCallback' => function (ServerRequestInterface $request, string $authenticationRedirect, ?string $normalizedMeUrl) {
* // If the request is authenticated, return an array with a `me` key containing the * // If the request is authenticated, return an array with a `me` key containing the
* // canonical URL of the currently logged-in user. * // canonical URL of the currently logged-in user.