Move todo stuff to todo file

And add some reading material
This commit is contained in:
Mike Bierlee 2022-10-13 01:05:27 +03:00
parent b82b50a16f
commit d71e6b8f6e
3 changed files with 15 additions and 8 deletions

View file

@ -15,14 +15,6 @@ Features:
- Internal configuration substitution (Value in config replaced by other path in config);
- Parse configuration from string or JSONValue instead of from disk.
TODO: add tutorial on:
- Config loading
- Config parsing
- Config manip
- Env and config var substitution
-- Escaping
## Getting started
### DUB Dependency
See the [DUB project page](https://code.dlang.org/packages/mirage-config) for instructions on how to include Mirage Config into your project.

12
TODO.md Normal file
View file

@ -0,0 +1,12 @@
# TODO
* Add tutorial
* Config loading
* Config parsing
* Config manip
* Env and config var substitution
* Escaping
* Java properties
* Add unicode escaping
* Support multi-line values with backslash
* Add escaping of key/value separator = and :

View file

@ -18,6 +18,9 @@ import mirage.keyvalue : KeyValueConfigFactory, SupportHashtagComments, SupportS
/**
* Creates configuration files from Java properties.
*
* Format specifications:
* https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Properties.html#load(java.io.Reader)
*/
class JavaPropertiesFactory : KeyValueConfigFactory!(
SupportHashtagComments.yes,