Skip to content

Commit 1c0e8a7

Browse files
committed
Merge pull request #50 from Nyholm/readme
Updated readme to be coherent with other repos
2 parents 2307dec + a022a31 commit 1c0e8a7

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,23 @@
11
# PSR-6 Integration tests
2+
[![Gitter](https://badges.gitter.im/php-cache/cache.svg)](https://gitter.im/php-cache/cache?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
3+
[![Latest Stable Version](https://poser.pugx.org/cache/integration-tests/v/stable)](https://packagist.org/packages/cache/integration-tests)
4+
[![Total Downloads](https://poser.pugx.org/cache/integration-tests/downloads)](https://packagist.org/packages/cache/integration-tests)
5+
[![Monthly Downloads](https://poser.pugx.org/cache/integration-tests/d/monthly.png)](https://packagist.org/packages/cache/integration-tests)
6+
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
27

3-
To make sure your implementation of PSR-6 is correct you should use this test suite.
8+
This repository contains integration tests to make sure your implementation of a PSR-6 cache follows the rules by PHP-FIG.
9+
It is a part of the PHP Cache organisation. To read about us please read the shared documentation at [www.php-cache.com](http://www.php-cache.com).
410

5-
### Usage
6-
7-
Install the dev-master version of this library.
11+
### Install
812

913
```bash
1014
composer require --dev cache/integration-tests:dev-master
1115
```
1216

17+
### Use
18+
1319
Create a test that looks like this:
20+
1421
```php
1522
class PoolIntegrationTest extends CachePoolTest
1623
{
@@ -22,6 +29,7 @@ class PoolIntegrationTest extends CachePoolTest
2229
```
2330

2431
You could also test your tag implementation:
32+
2533
```php
2634
class TagIntegrationTest extends TaggableCachePoolTest
2735
{
@@ -30,4 +38,9 @@ class TagIntegrationTest extends TaggableCachePoolTest
3038
return new CachePool();
3139
}
3240
}
33-
```
41+
```
42+
43+
### Contribute
44+
45+
Contributions are very welcome! Send a pull request or
46+
report any issues you find on the [issue tracker](http://issues.php-cache.com).

0 commit comments

Comments
 (0)