Skip to content

Commit 0bff623

Browse files
committed
Merge pull request #3 from php-cache/readme
Improved readme
2 parents cc03e6a + 97d597b commit 0bff623

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

README.md

+22-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,24 @@
1-
# Redis PSR-6 adapter using PhpRedis
2-
[![Build Status](https://travis-ci.org/php-cache/redis-adapter.svg?branch=master)](https://travis-ci.org/php-cache/redis-adapter) [![codecov.io](https://codecov.io/github/php-cache/redis-adapter/coverage.svg?branch=master)](https://codecov.io/github/php-cache/redis-adapter?branch=master)
1+
# Redis PSR-6 Cache pool
2+
[![Latest Stable Version](https://poser.pugx.org/cache/redis-adapter/v/stable)](https://packagist.org/packages/cache/redis-adapter) [![codecov.io](https://codecov.io/github/php-cache/redis-adapter/coverage.svg?branch=master)](https://codecov.io/github/php-cache/redis-adapter?branch=master) [![Build Status](https://travis-ci.org/php-cache/redis-adapter.svg?branch=master)](https://travis-ci.org/php-cache/redis-adapter) [![Total Downloads](https://poser.pugx.org/cache/redis-adapter/downloads)](https://packagist.org/packages/cache/redis-adapter) [![Monthly Downloads](https://poser.pugx.org/cache/redis-adapter/d/monthly.png)](https://packagist.org/packages/cache/redis-adapter) [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
33

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

6-
This implementation is using [PhpRedis](https://github.com/phpredis/phpredis). If you want an adapter with
7-
[Predis](https://github.com/nrk/predis) you should look at our [Predis adapter](https://github.com/php-cache/predis-adapter).
7+
This implementation is using [PhpRedis](https://github.com/phpredis/phpredis). If you want an adapter with
8+
[Predis](https://github.com/nrk/predis) you should look at our [Predis adapter](https://github.com/php-cache/predis-adapter).
9+
10+
### Install
11+
12+
```bash
13+
composer require cache/redis-adapter
14+
```
15+
16+
### Configure
17+
18+
To create an instance of `RedisCachePool` you need to configure a `\Redis` client.
19+
20+
```php
21+
$client = new \Redis();
22+
$client->connect('127.0.0.1', 6379);
23+
$pool = new RedisCachePool($client);
24+
```

0 commit comments

Comments
 (0)