Skip to content

Commit 7c67f16

Browse files
committed
Updated all the readmes to be coherent
1 parent 4b2352c commit 7c67f16

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

README.md

+14-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
1-
# Filesystem PSR-6 Cache pool
2-
[![Latest Stable Version](https://poser.pugx.org/cache/filesystem-adapter/v/stable)](https://packagist.org/packages/cache/filesystem-adapter) [![codecov.io](https://codecov.io/github/php-cache/filesystem-adapter/coverage.svg?branch=master)](https://codecov.io/github/php-cache/filesystem-adapter?branch=master) [![Build Status](https://travis-ci.org/php-cache/filesystem-adapter.svg?branch=master)](https://travis-ci.org/php-cache/filesystem-adapter) [![Total Downloads](https://poser.pugx.org/cache/filesystem-adapter/downloads)](https://packagist.org/packages/cache/filesystem-adapter) [![Monthly Downloads](https://poser.pugx.org/cache/filesystem-adapter/d/monthly.png)](https://packagist.org/packages/cache/filesystem-adapter) [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
3-
4-
This is a PSR-6 cache implementation for Filesystem. It is a part of the PHP Cache organization. To read about
1+
# Filesystem PSR-6 Cache pool
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/filesystem-adapter/v/stable)](https://packagist.org/packages/cache/filesystem-adapter)
4+
[![Total Downloads](https://poser.pugx.org/cache/filesystem-adapter/downloads)](https://packagist.org/packages/cache/filesystem-adapter)
5+
[![Monthly Downloads](https://poser.pugx.org/cache/filesystem-adapter/d/monthly.png)](https://packagist.org/packages/cache/filesystem-adapter)
6+
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
7+
8+
This is a PSR-6 cache implementation using Filesystem. It is a part of the PHP Cache organisation. To read about
59
features like tagging and hierarchy support please read the shared documentation at [www.php-cache.com](http://www.php-cache.com).
610

711
This implementation is using the excellent [Flysystem](http://flysystem.thephpleague.com/).
@@ -12,7 +16,7 @@ This implementation is using the excellent [Flysystem](http://flysystem.thephple
1216
composer require cache/filesystem-adapter
1317
```
1418

15-
### Configure
19+
### Use
1620

1721
To create an instance of `FilesystemCachePool` you need to configure a `Filesystem` and its adapter.
1822

@@ -26,3 +30,8 @@ $filesystem = new Filesystem($filesystemAdapter);
2630

2731
$pool = new FilesystemCachePool($filesystem);
2832
```
33+
34+
### Contribute
35+
36+
Contributions are very welcome! Send a pull request to the [main repository](https://github.com/php-cache/cache) or
37+
report any issues you find on the [issue tracker](http://issues.php-cache.com).

0 commit comments

Comments
 (0)