Skip to content

Commit d1825d5

Browse files
authored
Merge pull request #49 from php-api-clients/update-readme
Updated README
2 parents 8f73823 + 7303f0e commit d1825d5

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

README.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
1-
# Client-side PSR-7 Oauth1 request signer for PHP `^7.0`
1+
# Client-side PSR-7 Oauth1 request signer for PHP `^8 || ^7.4`
22

3-
[![Build Status](https://travis-ci.org/php-api-clients/psr7-oauth1.svg?branch=master)](https://travis-ci.org/php-api-clients/psr7-oauth1)
3+
[![Continuous Integration](https://github.com/php-api-clients/psr7-oauth1/actions/workflows/ci.yml/badge.svg?event=push)](https://github.com/php-api-clients/psr7-oauth1/actions/workflows/ci.yml)
44
[![Latest Stable Version](https://poser.pugx.org/api-clients/psr7-oauth1/v/stable.png)](https://packagist.org/packages/api-clients/psr7-oauth1)
55
[![Total Downloads](https://poser.pugx.org/api-clients/psr7-oauth1/downloads.png)](https://packagist.org/packages/api-clients/psr7-oauth1/stats)
66
[![Code Coverage](https://scrutinizer-ci.com/g/php-api-clients/psr7-oauth1/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/php-api-clients/psr7-oauth1/?branch=master)
77
[![License](https://poser.pugx.org/api-clients/psr7-oauth1/license.png)](https://packagist.org/packages/api-clients/psr7-oauth1)
8-
[![PHP 7 ready](http://php7ready.timesplinter.ch/php-api-clients/psr7-oauth1/badge.svg)](https://appveyor-ci.org/php-api-clients/psr7-oauth1)
98

109
# Installation
1110

1211
To install via [Composer](http://getcomposer.org/), use the command below, it will automatically detect the latest version and bind it with `^`.
1312

1413
```bash
15-
composer require api-clients/psr7-oauth1
14+
composer require api-clients/psr7-oauth1
1615
```
1716

1817
In case you need to support `5.5+` as well in your package, we suggest you use the following command:
@@ -21,10 +20,10 @@ In case you need to support `5.5+` as well in your package, we suggest you use t
2120
composer require api-clients/psr7-oauth1:^1.0
2221
```
2322

24-
However since `1.0` and `2.0` of this package are 100% compatible, we recommend you use the following command to support both:
23+
However, since `1.0`, `2.0`, and `3.0` of this package are 100% compatible, we recommend you use the following command to support both:
2524

2625
```bash
27-
composer require "api-clients/psr7-oauth1:^2.0 || ^1.0"
26+
composer require "api-clients/psr7-oauth1:^2.0 || ^1.0"
2827
```
2928

3029
# Example
@@ -34,7 +33,6 @@ composer require "api-clients/psr7-oauth1:^2.0 || ^1.0"
3433

3534
use ApiClients\Tools\Psr7\Oauth1\Definition;
3635
use ApiClients\Tools\Psr7\Oauth1\RequestSigning\RequestSigner;
37-
use ApiClients\Tools\Psr7\Oauth1\Signature\HmacSha1Signature;
3836

3937
// Pass it a PSR-7 request and it returns a signed PSR7 request you can use in any PSR7 capable HTTP client.
4038
// By default a HMAC-SHA1 signature will be used, this can be changed, see examples below how to do that.
@@ -154,7 +152,7 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
154152

155153
The MIT License (MIT)
156154

157-
Copyright (c) 2016 Cees-Jan Kiewiet & Beau Simensen
155+
Copyright (c) 2021 Cees-Jan Kiewiet & Beau Simensen
158156

159157
Permission is hereby granted, free of charge, to any person obtaining a copy
160158
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)