Skip to content

Commit 364d826

Browse files
committed
Updated README
1 parent 2456f51 commit 364d826

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

README.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,29 @@ All contained key-value stores implement the interface [`KeyValueStore`]. The
1818
following stores are currently supported:
1919

2020
* [`ArrayStore`]
21-
* [`CachedStore`]
2221
* [`JsonFileStore`]
2322
* [`NullStore`]
2423
* [`PhpRedisStore`]
2524
* [`PredisStore`]
2625
* [`RiakStore`]
2726

27+
The interface [`CountableStore`] is supported by the following classes:
28+
29+
* [`ArrayStore`]
30+
* [`JsonFileStore`]
31+
* [`NullStore`]
32+
* [`CountableDecorator`]
33+
34+
The interface [`SortableStore`] is supported by the following classes:
35+
36+
* [`ArrayStore`]
37+
* [`JsonFileStore`]
38+
* [`NullStore`]
39+
* [`SortableDecorator`]
40+
41+
The decorator [`CachingDecorator`] exists for caching another store instance
42+
in a Doctrine cache.
43+
2844
FAQ
2945
---
3046

@@ -50,8 +66,8 @@ kind of database).
5066
Hence the two libraries fulfill two very different purposes, even if their
5167
interfaces and implementations are often similar.
5268

53-
The [`CachedStore`] actually uses a Doctrine Cache object to cache the data of
54-
a persistent [`KeyValueStore`].
69+
The [`CachingDecorator`] actually uses a Doctrine Cache object to cache the data
70+
of a persistent [`KeyValueStore`].
5571

5672
Authors
5773
-------
@@ -97,10 +113,14 @@ All contents of this package are licensed under the [MIT license].
97113
[Doctrine Cache]: https://github.com/doctrine/cache
98114
[API Documentation]: https://webmozart.github.io/key-value-store/api
99115
[`KeyValueStore`]: https://webmozart.github.io/key-value-store/api/latest/class-Webmozart.KeyValueStore.Api.KeyValueStore.html
116+
[`CountableStore`]: https://webmozart.github.io/key-value-store/api/latest/class-Webmozart.KeyValueStore.Api.CountableStore.html
117+
[`SortableStore`]: https://webmozart.github.io/key-value-store/api/latest/class-Webmozart.KeyValueStore.Api.SortableStore.html
100118
[`ArrayStore`]: https://webmozart.github.io/key-value-store/api/latest/class-Webmozart.KeyValueStore.ArrayStore.html
101-
[`CachedStore`]: https://webmozart.github.io/key-value-store/api/latest/class-Webmozart.KeyValueStore.CachedStore.html
102119
[`JsonFileStore`]: https://webmozart.github.io/key-value-store/api/latest/class-Webmozart.KeyValueStore.JsonFileStore.html
103120
[`NullStore`]: https://webmozart.github.io/key-value-store/api/latest/class-Webmozart.KeyValueStore.NullStore.html
104121
[`PhpRedisStore`]: https://webmozart.github.io/key-value-store/api/latest/class-Webmozart.KeyValueStore.PhpRedisStore.html
105122
[`PredisStore`]: https://webmozart.github.io/key-value-store/api/latest/class-Webmozart.KeyValueStore.PredisStore.html
106123
[`RiakStore`]: https://webmozart.github.io/key-value-store/api/latest/class-Webmozart.KeyValueStore.RiakStore.html
124+
[`CachingDecorator`]: https://webmozart.github.io/key-value-store/api/latest/class-Webmozart.KeyValueStore.Decorator.CachingDecorator.html
125+
[`CountableDecorator`]: https://webmozart.github.io/key-value-store/api/latest/class-Webmozart.KeyValueStore.Decorator.CountableDecorator.html
126+
[`SortableDecorator`]: https://webmozart.github.io/key-value-store/api/latest/class-Webmozart.KeyValueStore.Decorator.SortableDecorator.html

0 commit comments

Comments
 (0)