diff --git a/README.md b/README.md index bf62666..6b92fa5 100644 --- a/README.md +++ b/README.md @@ -24,21 +24,114 @@ use ApiClients\Tools\Psr7\Oauth1\Definition; use ApiClients\Tools\Psr7\Oauth1\RequestSigning\RequestSigner; use ApiClients\Tools\Psr7\Oauth1\Signature\HmacSha1Signature; +// Pass it a PSR-7 request and it returns a signed PSR7 request you can use in any PSR7 capable HTTP client. +// By default a HMAC-SHA1 signature will be used, this can be changed, see examples below how to do that. +$request = (new RequestSigner( + new Definition\ConsumerKey('consumer_key'), + new Definition\ConsumerSecret('consumer_secret') +))->withAccessToken( + new Definition\AccessToken('token_key'), + new Definition\TokenSecret('token_secret') +)->sign($request); +``` + +# Suppported signatures + +All supported signatures are HMAC signatures. + +## MD5 + +Signs request with `HMAC-MD5`. Usage: + +```php +withAccessToken( - new Definition\AccessToken('token_key'), - new Definition\TokenSecret('token_secret') -)->sign($request); +## SHA256 + +Signs request using `HMAC-SHA256`. Usage: + +```php +