Skip to content

Commit df5b71a

Browse files
committed
Update Documentation
1 parent ea830cc commit df5b71a

File tree

3 files changed

+11
-46
lines changed

3 files changed

+11
-46
lines changed

.travis.yml

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

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ of engines available in this library that is PSR-16 compliant:
1616

1717
| Class | Description |
1818
|:---------------------------------------------------------------------------------|:--------------------------------------------------------------------|
19-
| [\ByJG\Cache\Psr16\NoCacheEngine](class-no-cache-engine.md) | Do nothing. Use it for disable the cache without change your code |
20-
| [\ByJG\Cache\Psr16\ArrayCacheEngine](class-array-cache-engine.md) | Local cache only using array. It does not persists between requests |
21-
| [\ByJG\Cache\Psr16\FileSystemCacheEngine](class-filesystem-cache-engine.md) | Save the cache result in the local file system |
22-
| [\ByJG\Cache\Psr16\MemcachedEngine](class-memcached-engine.md) | Uses the Memcached as the cache engine |
23-
| [\ByJG\Cache\Psr16\RedisCachedEngine](class-redis-cache-engine.md) | uses the Redis as cache |
24-
| [\ByJG\Cache\Psr16\SessionCachedEngine](class-session-cache-engine.md) | uses the PHP session as cache |
25-
| [\ByJG\Cache\Psr16\ShmopCachedEngine](class-shmop-cache-engine.md) | uses the shared memory area for cache |
19+
| [\ByJG\Cache\Psr16\NoCacheEngine](docs/class-no-cache-engine.md) | Do nothing. Use it for disable the cache without change your code |
20+
| [\ByJG\Cache\Psr16\ArrayCacheEngine](docs/class-array-cache-engine.md) | Local cache only using array. It does not persists between requests |
21+
| [\ByJG\Cache\Psr16\FileSystemCacheEngine](docs/class-filesystem-cache-engine.md) | Save the cache result in the local file system |
22+
| [\ByJG\Cache\Psr16\MemcachedEngine](docs/class-memcached-engine.md) | Uses the Memcached as the cache engine |
23+
| [\ByJG\Cache\Psr16\RedisCachedEngine](docs/class-redis-cache-engine.md) | uses the Redis as cache |
24+
| [\ByJG\Cache\Psr16\SessionCachedEngine](docs/class-session-cache-engine.md) | uses the PHP session as cache |
25+
| [\ByJG\Cache\Psr16\ShmopCachedEngine](docs/class-shmop-cache-engine.md) | uses the shared memory area for cache |
2626

2727
To create a new Cache Instance just create the proper cache engine and use it:
2828

@@ -41,7 +41,7 @@ if ($cache->has('key')) {
4141
$object = $cache->get('key');
4242
```
4343

44-
See more PSR-16 examples [here](basic-usage-psr16-simplecache.md)
44+
See more PSR-16 examples [here](docs/basic-usage-psr16-simplecache.md)
4545

4646
## PSR-6
4747

@@ -61,7 +61,7 @@ $cachePool = \ByJG\Cache\Factory::createFilePool();
6161
$cachePool = new CachePool(new FileSystemCacheEngine());
6262
```
6363

64-
See more PSR-6 examples [here](basic-usage-psr6-cachepool.md)
64+
See more PSR-6 examples [here](docs/basic-usage-psr6-cachepool.md)
6565

6666
## List of Available Factory Commands
6767

@@ -89,7 +89,7 @@ The Common parameters are:
8989

9090
You can add a PSR Log compatible to the constructor in order to get Log of the operations
9191

92-
See log examples [here](setup-log-handler.md)
92+
See log examples [here](docs/setup-log-handler.md)
9393

9494
## Use a PSR-11 container to retrieve the cache keys
9595

docs/class-array-cache-engine.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Class ArrayCacheEngine
22

33
This class is a simple cache engine that uses an array to store the values.
4-
It does not persists between requests.
4+
It does not persist between requests.
55

66
It is ideal to use on unit tests or when you need a simple cache engine.
77

0 commit comments

Comments
 (0)