diff --git a/README.md b/README.md index 291e320..8ad59fc 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Config: Simple, efficient YAML -> `struct` converter +# Configy: Simple, efficient YAML -> `struct` converter ## Why (would I use this) ? @@ -78,7 +78,7 @@ This demonstrate a few important properties of the config parser: ## Full documentation -The full, up-to-date API documentation can be found [here](https://bosagora.github.io/configy/). +The full, up-to-date API documentation can be found [here](https://dlang-community.github.io/configy/). A list of example for common use cases can be found [here](doc/FAQ.md). ## Rich error reporting diff --git a/doc/FAQ.md b/doc/FAQ.md index c0e7022..22ed3ff 100644 --- a/doc/FAQ.md +++ b/doc/FAQ.md @@ -20,8 +20,9 @@ not part of the `struct` definition will result in an error, indicating what fie allowed for the section. This is the default as it prevent any unnoticed misconfiguration that would result from a typo to an optional field name. -To disable `strict` parsing, simply pass `false` as the optional parameter to either -`parseConfigFile`, `parseConfigString`, or `parseConfigFileSimple` method. +To disable `strict` parsing, simply pass `StrictMode.Ignore` as the optional parameter +to either `parseConfigFile`, `parseConfigString`, or `parseConfigFileSimple` method. +To notify the user whithout triggering an error, use `StrictMode.Warn` instead. ### Make a field required