Skip to content

Commit 0d31b93

Browse files
committed
Change project README to reflect recent changes.
1 parent d56faf3 commit 0d31b93

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,22 @@ enabled in order for this package to work.
4646

4747
## Usage
4848

49-
The functionality provided by this package is exposed mostly through these classes:
49+
This package has responses to request for:
5050

51-
@TODO: Add required code block illustrating how to use
51+
- OAuth2 Token
52+
- OpenID Connect Authorization
53+
- Server configuration (usually made to `/.well-known/openid-configuration`)
5254

53-
- @TODO: List main classes
55+
The classes that provide this functionality work with any [PSR-7](http://www.php-fig.org/psr/psr-7/).
56+
compliant Request and Response objects.(i.e. classes that implement the
57+
`Psr\Http\Message\ResponseInterface` and `Psr\Http\Message\ServerRequestInterface`, respectively).
58+
59+
This functionality is exposed by the `Pdsinterop\Solid\Auth\Server`, with the
60+
help of `League\OAuth2\Server\AuthorizationServer`.
61+
62+
Besides a Request, Response and AuthorizationServer, the `Pdsinterop\Solid\Auth\Server` requires a Configuration and User object.
63+
64+
A [full example](./tests/example.php) has been provided to help you understand how to integrate this library.
5465

5566
See the "API" section for detailed usage examples.
5667

0 commit comments

Comments
 (0)