Skip to content

Commit eb82eb3

Browse files
committed
Update for push to central documentation
1 parent 15c46f7 commit eb82eb3

File tree

3 files changed

+18
-73
lines changed

3 files changed

+18
-73
lines changed

.travis.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,11 @@ install:
2525

2626
script:
2727
- vendor/bin/phpunit --stderr
28+
29+
jobs:
30+
include:
31+
- stage: documentation
32+
if: branch = master
33+
before_install: skip
34+
install: skip
35+
script: "curl https://opensource.byjg.com/add-doc.sh | bash /dev/stdin php cache-engine-php"

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
11
# Cache Engine
22

3-
[![Opensource ByJG](https://img.shields.io/badge/opensource-byjg.com-brightgreen.svg)](http://opensource.byjg.com)
3+
[![Opensource ByJG](https://img.shields.io/badge/opensource-byjg-success.svg)](http://opensource.byjg.com)
4+
[![GitHub source](https://img.shields.io/badge/Github-source-informational?logo=github)](https://github.com/byjg/cache-engine-php/)
5+
[![GitHub license](https://img.shields.io/github/license/byjg/cache-engine-php.svg)](https://opensource.byjg.com/opensource/licensing.html)
6+
[![GitHub release](https://img.shields.io/github/release/byjg/cache-engine-php.svg)](https://github.com/byjg/cache-engine-php/releases/)
47
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/byjg/cache-engine-php/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/byjg/cache-engine-php/?branch=master)
58
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/f643fd22-8ab1-4f41-9bef-f9f9e127ec0d/mini.png)](https://insight.sensiolabs.com/projects/f643fd22-8ab1-4f41-9bef-f9f9e127ec0d)
6-
[![Build Status](https://travis-ci.org/byjg/cache-engine-php.svg?branch=master)](https://travis-ci.org/byjg/cache-engine-php)
9+
[![Build Status](https://travis-ci.com/byjg/cache-engine-php.svg?branch=master)](https://travis-ci.com/byjg/cache-engine-php)
710

811

912

1013
A multi-purpose cache engine PSR-6 and PSR-16 implementation with several drivers.
1114

12-
# Cache Engine PSR-16 compliant
15+
## PSR-16
1316

1417
PSR-16 defines a Simple Cache interface with less verbosity than PSR-6. Below a list
1518
of engines available in this library that is PSR-16 compliant:
@@ -44,7 +47,7 @@ $object = $cache->get('key');
4447

4548
See more PSR-16 examples [here](docs/basic-usage-psr16-simplecache.md)
4649

47-
# Cache Engine PSR-6 compliant
50+
## PSR-6
4851

4952
The PSR-6 implementation use the engines defined above. PSR-6 is more verbosity and
5053
have an extra layer do get and set the cache values.
@@ -64,7 +67,7 @@ $cachePool = new CachePool(new FileSystemCacheEngine());
6467

6568
See more PSR-6 examples [here](docs/basic-usage-psr6-cachepool.md)
6669

67-
# List of Available Factory Commands
70+
## List of Available Factory Commands
6871

6972
**Note: All parameters are optional**
7073

@@ -88,7 +91,7 @@ The Common parameters are:
8891
- servers: An array of memcached servers. E.g.: `[ '127.0.0.1:11211' ]`
8992
- config: Specific setup for shmop. E.g.: `[ 'max-size' => 524288, 'default-permission' => '0700' ]`
9093

91-
# Logging cache commands
94+
## Logging cache commands
9295

9396
You can add a PSR Log compatible to the constructor in order to get Log of the operations
9497

@@ -103,7 +106,7 @@ composer require "byjg/cache-engine=4.0.*"
103106
```
104107

105108

106-
# Running Unit Testes
109+
## Running Unit Testes
107110

108111
```
109112
phpunit --stderr

_config.yml

Lines changed: 0 additions & 66 deletions
This file was deleted.

0 commit comments

Comments
 (0)