Skip to content

Commit eb2555e

Browse files
committed
update README
1 parent 153144c commit eb2555e

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,29 @@
11
# PSR Cache
2+
3+
An implementation of the [PSR-6](https://www.php-fig.org/psr/psr-6/) Caching interfaces and the [PSR-16](https://www.php-fig.org/psr/psr-16/) Simple Cache that focuses on code quality.
4+
5+
## About
6+
7+
| Info | Value |
8+
|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
9+
| Latest release | [![Packagist Version](https://img.shields.io/packagist/v/ingenioz-it/psr-cache)](https://packagist.org/packages/ingenioz-it/psr-cache) |
10+
| Requires | ![PHP from Packagist](https://img.shields.io/packagist/php-v/ingenioz-it/psr-cache.svg) |
11+
| License | ![Packagist](https://img.shields.io/packagist/l/ingenioz-it/psr-cache) |
12+
| Unit tests | [![tests](https://github.com/IngeniozIT/psr-cache/actions/workflows/1-tests.yml/badge.svg)](https://github.com/IngeniozIT/psr-cache/actions/workflows/1-tests.yml) |
13+
| Code coverage | [![Code Coverage](https://codecov.io/gh/IngeniozIT/psr-cache/branch/master/graph/badge.svg)](https://codecov.io/gh/IngeniozIT/psr-cache) |
14+
| Code quality | [![code-quality](https://github.com/IngeniozIT/psr-cache/actions/workflows/2-code-quality.yml/badge.svg)](https://github.com/IngeniozIT/psr-cache/actions/workflows/2-code-quality.yml) |
15+
| Quality tested with | [phpunit](https://github.com/sebastianbergmann/phpunit), [phan](https://github.com/phan/phan), [psalm](https://github.com/vimeo/psalm), [phpcs](https://github.com/squizlabs/PHP_CodeSniffer), [phpstan](https://github.com/phpstan/phpstan), [phpmd](https://github.com/phpmd/phpmd), [infection](https://github.com/infection/infection) |
16+
17+
## Installation
18+
19+
```sh
20+
composer require ingenioz-it/psr-cache
21+
```
22+
23+
## Full documentation
24+
25+
You can list all the available features by running
26+
27+
```sh
28+
composer testdox
29+
```

composer.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@
1212
],
1313
"minimum-stability": "dev",
1414
"prefer-stable": true,
15+
"provide": {
16+
"psr/cache-implementation": "3.0",
17+
"psr/simple-cache-implementation": "3.0"
18+
},
1519
"require": {
1620
"php": ">=8.2",
1721
"ingenioz-it/clock": "^1.0",

0 commit comments

Comments
 (0)