From be559a6117d6569008b5274d2056012e27fe9f09 Mon Sep 17 00:00:00 2001 From: Tobias Sette Date: Tue, 21 May 2019 03:04:38 -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 | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 2818533..801e872 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,12 @@ -PSR Http Message -================ +HTTP message interfaces +============== -This repository holds all interfaces/classes/traits related to -[PSR-7](http://www.php-fig.org/psr/psr-7/). +This repository holds all interfaces related to [PSR-7 (HTTP message interfaces)][psr-url]. -Note that this is not a HTTP message implementation of its own. It is merely an -interface that describes a HTTP message. See the specification for more details. +Note that this is not an HTTP Message implementation of its own. It is merely interfaces that describe the components of an HTTP Message. -Usage ------ +You can find [implementations][implementation-url] and [installation instructions][package-url] for the specification on the packagist. -We'll certainly need some stuff in here. \ No newline at end of file +[psr-url]: http://www.php-fig.org/psr/psr-7/ +[package-url]: https://packagist.org/packages/psr/http-message +[implementation-url]: https://packagist.org/providers/psr/http-message-implementation From 3ba8f81a32088a59de2470cbdfae7a31de6429db Mon Sep 17 00:00:00 2001 From: Tobias Sette Date: Thu, 23 May 2019 13:36:51 -0300 Subject: [PATCH 2/2] chore: update README Changes requested in https://github.com/php-fig/http-factory/pull/9 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 801e872..5391caf 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ This repository holds all interfaces related to [PSR-7 (HTTP message interfaces) Note that this is not an HTTP Message implementation of its own. It is merely interfaces that describe the components of an HTTP Message. -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]: http://www.php-fig.org/psr/psr-7/ [package-url]: https://packagist.org/packages/psr/http-message