From eb365efd762ec6594e42dee2d7330a2589801fbe Mon Sep 17 00:00:00 2001 From: Tobias Sette Date: Tue, 21 May 2019 02:28:47 -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 | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 43641d1..769b908 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,12 @@ -PHP FIG Simple Cache PSR -======================== +Common Interface for Caching Libraries +============== -This repository holds all interfaces related to PSR-16. +This repository holds all interfaces related to [PSR-16 (Common Interface for Caching Libraries)][psr-url]. -Note that this is not a cache implementation of its own. It is merely an interface that describes a cache implementation. See [the specification](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-16-simple-cache.md) for more details. +Note that this is not a Caching implementation of its own. It is merely interfaces that describe the components of a Simple Caching mechanism. -You can find implementations of the specification by looking for packages providing the [psr/simple-cache-implementation](https://packagist.org/providers/psr/simple-cache-implementation) virtual package. +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-16/ +[package-url]: https://packagist.org/packages/psr/simple-cache +[implementation-url]: https://packagist.org/providers/psr/simple-cache-implementation From 840c02f28c691ffbed705e122a0b8ffd771286e0 Mon Sep 17 00:00:00 2001 From: Tobias Sette Date: Thu, 23 May 2019 13:36:14 -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 769b908..5793544 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ This repository holds all interfaces related to [PSR-16 (Common Interface for Ca Note that this is not a Caching implementation of its own. It is merely interfaces that describe the components of a Simple Caching mechanism. -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-16/ [package-url]: https://packagist.org/packages/psr/simple-cache