Skip to content

Commit 513997f

Browse files
committed
Updated all the readmes to be coherent
1 parent 190e7ff commit 513997f

File tree

1 file changed

+23
-17
lines changed

1 file changed

+23
-17
lines changed

README.md

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

48
This is a implementation for the PSR-6 for an hierarchical cache architecture.
59

610
If you have a cache key like `|users|:uid|followers|:fid|likes` where `:uid` and `:fid` are arbitrary integers. You
711
may flush all followers by flushing `|users|:uid|followers`.
12+
13+
It is a part of the PHP Cache organisation. To read about features like tagging and hierarchy support please read
14+
the shared documentation at [www.php-cache.com](http://www.php-cache.com).
15+
16+
### Install
17+
18+
```bash
19+
composer require cache/hierarchical-cache
20+
```
821

9-
```php
10-
$user = 4711;
11-
for ($i = 0; $i < 100; $i++) {
12-
$item = $pool->getItem(sprintf('|users|%d|followers|%d|likes', $user, $i));
13-
$item->set('Justin Bieber');
14-
$pool->save($item);
15-
}
22+
### Use
1623

17-
$pool->hasItem('|users|4711|followers|12|likes'); // True
24+
Read the [documentation on usage](http://www.php-cache.com/en/latest/hierarchy/).
1825

19-
$pool->deleteItem('|users|4711|followers');
26+
### Implement
2027

21-
$pool->hasItem('|users|4711|followers|12|likes'); // False
22-
```
28+
Read the [documentation on implementation](http://www.php-cache.com/en/latest/implementing-cache-pools/hierarchy/).
29+
30+
### Contribute
31+
32+
Contributions are very welcome! Send a pull request to the [main repository](https://github.com/php-cache/cache) or
33+
report any issues you find on the [issue tracker](http://issues.php-cache.com).
2334

24-
| Feature | Supported |
25-
| ------- | --------- |
26-
| Flush everything | Yes
27-
| Expiration time | Yes
28-
| Tagging | Yes

0 commit comments

Comments
 (0)