Skip to content

Commit 913f0bc

Browse files
committed
Updated all the readmes to be coherent
1 parent 6b9e57e commit 913f0bc

File tree

1 file changed

+28
-8
lines changed

1 file changed

+28
-8
lines changed

README.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,30 @@
1-
# Memcache PSR-6 adapter
2-
[![Build Status](https://travis-ci.org/php-cache/memcache-adapter.svg?branch=master)](https://travis-ci.org/php-cache/memcache-adapter) [![codecov.io](https://codecov.io/github/php-cache/memcache-adapter/coverage.svg?branch=master)](https://codecov.io/github/php-cache/memcache-adapter?branch=master)
1+
# Memcache 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/memcache-adapter/v/stable)](https://packagist.org/packages/cache/memcache-adapter)
4+
[![Total Downloads](https://poser.pugx.org/cache/memcache-adapter/downloads)](https://packagist.org/packages/cache/memcache-adapter)
5+
[![Monthly Downloads](https://poser.pugx.org/cache/memcache-adapter/d/monthly.png)](https://packagist.org/packages/cache/memcache-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 an memcache cache. This implementation supports tags.
8+
This is a PSR-6 cache implementation using Memcache. 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-
| Feature | Supported |
7-
| ------- | --------- |
8-
| Flush everything | Yes
9-
| Expiration time | Yes
10-
| Tagging | Yes
11+
### Install
12+
13+
```bash
14+
composer require cache/memcache-adapter
15+
```
16+
17+
### Use
18+
19+
To create an instance of `MemcacheCachePool` you need to configure a `\Memcache` client.
20+
21+
```php
22+
$client = new Memcache();
23+
$client->connect('localhost', 11211);
24+
$pool = new MemcacheCachePool($client);
25+
```
26+
27+
### Contribute
28+
29+
Contributions are very welcome! Send a pull request to the [main repository](https://github.com/php-cache/cache) or
30+
report any issues you find on the [issue tracker](http://issues.php-cache.com).

0 commit comments

Comments
 (0)