Skip to content

Commit 44259cf

Browse files
committed
Updated all the readmes to be coherent
1 parent 6b837b2 commit 44259cf

File tree

1 file changed

+30
-5
lines changed

1 file changed

+30
-5
lines changed

README.md

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,32 @@
1-
# Redis PSR-6 adapter using Predis
2-
[![Build Status](https://travis-ci.org/php-cache/predis-adapter.svg?branch=master)](https://travis-ci.org/php-cache/predis-adapter) [![codecov.io](https://codecov.io/github/php-cache/predis-adapter/coverage.svg?branch=master)](https://codecov.io/github/php-cache/predis-adapter?branch=master)
1+
# Predis 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/predis-adapter/v/stable)](https://packagist.org/packages/cache/predis-adapter)
4+
[![Total Downloads](https://poser.pugx.org/cache/predis-adapter/downloads)](https://packagist.org/packages/cache/predis-adapter)
5+
[![Monthly Downloads](https://poser.pugx.org/cache/predis-adapter/d/monthly.png)](https://packagist.org/packages/cache/predis-adapter)
6+
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
37

4-
This is a implementation for the PSR-6 for Redis cache. This implementation supports tags.
8+
This is a PSR-6 cache implementation using Predis. It is a part of the PHP Cache organisation. To read about
9+
features like tagging and hierarchy support please read the shared documentation at [www.php-cache.com](http://www.php-cache.com).
510

6-
This implementation is using [Predis](https://github.com/nrk/predis). If you want an adapter with
7-
[PHPRedis](https://github.com/phpredis/phpredis) you should look at our [Redis adapter](https://github.com/php-cache/redis-adapter).
11+
This implementation is using [Predis](https://github.com/nrk/predis). If you want an adapter with
12+
[PhpRedis](https://github.com/phpredis/phpredis) you should look at our [Redis adapter](https://github.com/php-cache/redis-adapter).
13+
14+
### Install
15+
16+
```bash
17+
composer require cache/predis-adapter
18+
```
19+
20+
### Use
21+
22+
To create an instance of `PredisCachePool` you need to configure a `\Predis\Client` object.
23+
24+
```php
25+
$client = new \Predis\Client('tcp:/127.0.0.1:6379');
26+
$pool = new PredisCachePool($client);
27+
```
28+
29+
### Contribute
30+
31+
Contributions are very welcome! Send a pull request to the [main repository](https://github.com/php-cache/cache) or
32+
report any issues you find on the [issue tracker](http://issues.php-cache.com).

0 commit comments

Comments
 (0)