From 31c8fb877d07b943de8ffc4e034002d7a9e833da Mon Sep 17 00:00:00 2001 From: Tobias Sette Date: Tue, 21 May 2019 02:39:27 -0300 Subject: [PATCH 1/2] docs: Standardize the README What: Standardizes the README file providing a common language and an implementation link. Why: There are differences between PSR's READMEs in regarding language and the lacking of implementations references. So I've updated all READMEs using the https://github.com/php-fig/http-factory as base. --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 41d362a..9627b36 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ HTTP Factories ============== -This repository holds all interfaces related to [PSR-17 (HTTP Message Factories)][psr-17]. -Please refer to the specification for a description. +This repository holds all interfaces related to [PSR-17 (HTTP Factories)][psr-url]. -You can find implementations of the specification by looking for packages providing the -[psr/http-factory-implementation](https://packagist.org/providers/psr/http-factory-implementation) virtual package. +Note that this is not a HTTP Factory implementation of its own. It is merely interfaces that describe the components of a HTTP Factory. -[psr-17]: https://www.php-fig.org/psr/psr-17/ +You can find [implementations][implementation-url] and [installation instructions][package-url] for the specification on the packagist. + +[psr-url]: https://www.php-fig.org/psr/psr-17/ +[package-url]: https://packagist.org/packages/psr/http-factory +[implementation-url]: https://packagist.org/providers/psr/http-factory-implementation From 0cf7890f4aa161bfb819ed2b0427ddec82c7fef6 Mon Sep 17 00:00:00 2001 From: Tobias Sette Date: Thu, 23 May 2019 13:28:35 -0300 Subject: [PATCH 2/2] Update README.md Co-Authored-By: Woody Gilk --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9627b36..bf8913b 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ This repository holds all interfaces related to [PSR-17 (HTTP Factories)][psr-ur Note that this is not a HTTP Factory implementation of its own. It is merely interfaces that describe the components of a HTTP Factory. -You can find [implementations][implementation-url] and [installation instructions][package-url] for the specification on the packagist. +The installable [package][package-url] and [implementations][implementation-url] are listed on Packagist. [psr-url]: https://www.php-fig.org/psr/psr-17/ [package-url]: https://packagist.org/packages/psr/http-factory