Skip to content

Commit f54e2c0

Browse files
committed
readme updated
1 parent c68cd04 commit f54e2c0

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

+10-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
11
# Filesystem data layer for Convoworks
22

3-
This library contains filesystem implementations for `\Convo\Core\IServiceDataProvider`, `\Convo\Core\IServiceParamsFactory` and `\Convo\Core\IServiceParamsFactory` Convoworks interfaces which serves for storing service related data.
3+
This library contains filesystem implementations for `\Convo\Core\IServiceDataProvider`, `\Convo\Core\IServiceParamsFactory`, `\Convo\Core\IServiceParamsFactory` and `Convo\Core\Media\IServiceMediaManager` Convoworks interfaces which are serving for data storage.
44

5+
In addition there is a simple filesystem `Psr\SimpleCache\CacheInterface` implementation too.
56

6-
## Usage
7+
### Service data
78

8-
If you are not using DI, you can initialize them like this:
9+
* `Convo\Data\Filesystem\FilesystemServiceDataProvider` implements `IServiceDataProvider` - stores service data
10+
* `Convo\Data\Filesystem\FilesystemServiceParams` implements `IServiceParams` - stores runtime service params
11+
* `Convo\Data\Filesystem\FilesystemServiceParamsFactory` implements `IServiceParamsFactory` - creates concrete service params storages
12+
* `Convo\Data\Filesystem\FilesystemServiceMediaManager` implements `IServiceMediaManager` - stores service media
913

14+
### Cache
15+
16+
* `Convo\Data\Filesystem\FilesystemCache` implements `CacheInterface` - cache is available to be used in Convoworks components

0 commit comments

Comments
 (0)