diff --git a/CHANGES.md b/CHANGES.md new file mode 100644 index 0000000..555d7ae --- /dev/null +++ b/CHANGES.md @@ -0,0 +1,9 @@ +# Mirage Config Changelog + +**Version 0.0.0** +* Initial version +* Add JSON format. +* Add Java properties format. +* Add environment value substitution. +* Add substitution of values from those on other paths. +* Add config value setter. \ No newline at end of file diff --git a/README.md b/README.md index a653e93..9cd6da9 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ Licensed under the terms of the MIT license - See [LICENSE.txt](LICENSE.txt) Toolkit for loading and using application configuration from various formats. Features: + - Load from various file formats such as JSON and Java properties; - Environment variable substitution; - Internal configuration substitution (Value in config replaced by other path in config); @@ -15,8 +16,13 @@ Features: This is a work in progress. More will follow. For now see `examples/` to learn how to use it. TODO: add tutorial on: + - Config loading - Config parsing - Config manip - Env and config var substitution --- Escaping \ No newline at end of file + -- Escaping + +## History + +For a full overview of changes, see [CHANGES.md](CHANGES.md)