Skip to content

Commit 7f16768

Browse files
committed
📖 clarify overview
1 parent ec5e519 commit 7f16768

File tree

2 files changed

+7
-5
lines changed

2 files changed

+7
-5
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,10 @@ A transparent, framework-agnostic, easily extensible PHP [PSR-18](https://www.ph
4444
- [PKCE Code Challenge](https://datatracker.ietf.org/doc/html/rfc7636) (Proof Key for Code Exchange)
4545
- Proprietary, OAuth-like authorization flows (e.g. [Last.fm](https://www.last.fm/api/authentication))
4646
- Invalidation of access tokens (if supported by the provider)
47-
- Provider instances act as [PSR-18](https://www.php-fig.org/psr/psr-18/) HTTP client, wrapping the given PSR-18 HTTP instance
48-
- Requests to the provider API will have required OAuth headers and tokens added automatically
4947
- Several built-in provider implementations ([see below](#implemented-providers))
48+
- Provider instances act as [PSR-18](https://www.php-fig.org/psr/psr-18/) HTTP client, wrapping the given PSR-18 HTTP instance
49+
- Requests to the provider API will have required OAuth headers and tokens added automatically
50+
- Optional token encryption via [`sodium_crypto_secretbox()`](https://www.php.net/manual/en/function.sodium-crypto-secretbox) for the internal storage engines
5051
- A unified user data object `AuthenticatedUser` via the `OAuthInterface::me()` method
5152

5253

@@ -166,5 +167,5 @@ I don't take responsibility for stolen OAuth tokens. Use at your own risk.
166167

167168
## Privacy policy
168169

169-
This library does not store or process user data on its own - it only handles the OAuth flow for an application.
170+
This library does not store or process user data on its own - it only handles the OAuth flow for an application.<br/>
170171
Implementers are responsible for a proper privacy policy in accordance with the service providers.

docs/Basics/Overview.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,10 @@ fully [PSR-7](https://www.php-fig.org/psr/psr-7/)/[PSR-17](https://www.php-fig.o
1616
- [PKCE Code Challenge](https://datatracker.ietf.org/doc/html/rfc7636) (Proof Key for Code Exchange)
1717
- Proprietary, OAuth-like authorization flows (e.g. [Last.fm](https://www.last.fm/api/authentication))
1818
- Invalidation of access tokens (if supported by the provider)
19-
- Provider instances act as [PSR-18](https://www.php-fig.org/psr/psr-18/) HTTP client, wrapping the given PSR-18 HTTP instance
20-
- Requests to the provider API will have required OAuth headers and tokens added automatically
2119
- Several built-in provider implementations ([see below](#implemented-providers))
20+
- Provider instances act as [PSR-18](https://www.php-fig.org/psr/psr-18/) HTTP client, wrapping the given PSR-18 HTTP instance
21+
- Requests to the provider API will have required OAuth headers and tokens added automatically
22+
- Optional token encryption via [`sodium_crypto_secretbox()`](https://www.php.net/manual/en/function.sodium-crypto-secretbox) for the internal storage engines
2223
- A unified user data object `AuthenticatedUser` via the `OAuthInterface::me()` method
2324

2425

0 commit comments

Comments
 (0)