diff --git a/README.md b/README.md index 49f9c60..8a690c8 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/TODO.md b/TODO.md new file mode 100644 index 0000000..a48d98c --- /dev/null +++ b/TODO.md @@ -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 : \ No newline at end of file diff --git a/source/mirage/java.d b/source/mirage/java.d index c1d7127..1c47041 100644 --- a/source/mirage/java.d +++ b/source/mirage/java.d @@ -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,