Skip to content
This repository was archived by the owner on Oct 26, 2024. It is now read-only.

Commit cfc3004

Browse files
committed
Update README.md
1 parent 51403b3 commit cfc3004

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,25 @@ This library is all about helping with the common little problems like having a
99
## Usage
1010
A lot of examples on how to use the classes can be found in the UnitTests. The whole collection is extensively tested and therefore quite stable.
1111
Feel free to contribute, suggest changes or help make it better.
12+
13+
## Contents
14+
You'll get following groups of classes which are interdependent
15+
16+
### Data
17+
This part consists of two distinct classes:
18+
* Data is a data store where you can easily store and retrieve data.
19+
* DataCollection ist a container to house items like objects, iterable.
20+
21+
### Config
22+
Here you get a static factory which is able to produce three types of configuration objects, based on Data class. All config objects take yaml files as source and provide easy access via get/set methods. See UnitTests for examples.
23+
Available types are:
24+
* ConfigDefault - basic config object, stores the yaml content "as is", provides get/set.
25+
* ConfigEnv - provides the possibility to get an environment-merged config. Based on the currently provided env, you'll have e.g. prod -> dev merged, with prod node as a master.
26+
* ConfigTimer is a specialised for of config to provide pre-generated DateTime objects for the Timer class.
27+
28+
### Timer
29+
Provides functionality to check if there's a current holiday, has configurable "timers" to check uf e.g. your hotline should be available etc.
30+
Extensive examples can be found within both, the TestData and UnitTests :-)
31+
32+
### Test
33+
TestData is just a helper for providing configurations for either Config and Timer. Have a look for YAML config examples.

0 commit comments

Comments
 (0)