Skip to content

Commit bf0108a

Browse files
committed
Add opensource.byjg.com github page
1 parent da6f19d commit bf0108a

File tree

2 files changed

+65
-7
lines changed

2 files changed

+65
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,16 @@
66
[![Build Status](https://travis-ci.org/byjg/cache-engine-php.svg?branch=master)](https://travis-ci.org/byjg/cache-engine-php)
77

88

9-
## Description
109

1110
A multi-purpose cache engine PSR-6 and PSR-16 implementation with several drivers.
1211

13-
## Cache Engine PSR-16 compliant
12+
# Cache Engine PSR-16 compliant
1413

1514
PSR-16 defines a Simple Cache interface with less verbosity than PSR-6. Below a list
1615
of engines available in this library that is PSR-16 compliant:
1716

17+
{:.table}
18+
1819
| Class | Description |
1920
|:----------------------------------------|:--------------------------------------------------------------------|
2021
| \ByJG\Cache\Psr16\NoCacheEngine | Do nothing. Use it for disable the cache without change your code |
@@ -43,7 +44,7 @@ $object = $cache->get('key');
4344

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

46-
## Cache Engine PSR-6 compliant
47+
# Cache Engine PSR-6 compliant
4748

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

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

66-
## List of Avaiable Factory Commands
67+
# List of Avaiable Factory Commands
6768

6869
**Note: All parameters are optional**
6970

@@ -85,18 +86,22 @@ The Commom parameters are:
8586
- servers: An array of memcached servers. E.g.: `[ '127.0.0.1:11211' ]`
8687
- config: Specific setup for shmop. E.g.: `[ 'max-size' => 524288, 'default-permission' => '0700' ]`
8788

88-
## Logging cache commands
89+
# Logging cache commands
8990

9091
You can add a PSR Log compatible to the constructor in order to get Log of the operations
9192

9293
See log examples [here](docs/setup-log-handler.md)
9394

9495
## Install
9596

96-
Just type: `composer require "byjg/cache-engine=4.0.*"`
97+
Just type:
98+
99+
```
100+
composer require "byjg/cache-engine=4.0.*"
101+
```
97102

98103

99-
## Running Unit Testes
104+
# Running Unit Testes
100105

101106
```
102107
phpunit --stderr

_config.yml

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: cache-engine-php
2+
3+
project:
4+
version: 4.0.0
5+
download_url: https://github.com/byjg/cache-engine-php/releases
6+
7+
license:
8+
software: MIT
9+
software_url: https://opensource.org/licenses/MIT
10+
11+
docs: MIT
12+
docs_url: https://opensource.org/licenses/MIT
13+
14+
git_edit_address: https://github.com/byjg/cache-engine-php/blob/master/
15+
16+
links:
17+
header:
18+
- title: GitHub
19+
url: https://github.com/byjg/cache-engine-php
20+
- title: ByJG
21+
url: https://opensource.byjg.com/
22+
footer:
23+
- title: GitHub
24+
url: https://github.com/byjg/cache-engine-php
25+
- title: Issues
26+
url: https://github.com/byjg/cache-engine-php/issues
27+
28+
ui:
29+
header:
30+
color1: "#080331"
31+
color2: "#0033cc"
32+
trianglify: true
33+
34+
social:
35+
github:
36+
user: byjg
37+
repo: cache-engine-php
38+
twitter:
39+
enabled: false
40+
via:
41+
hash: opensourcebyjg
42+
account:
43+
facebook:
44+
enabled: false
45+
profileUrl:
46+
47+
analytics:
48+
google: UA-130014324-1
49+
50+
# Build settings
51+
markdown: kramdown
52+
remote_theme: allejo/jekyll-docs-theme
53+

0 commit comments

Comments
 (0)