dub-mirrors/mirage-config
1
0
Fork 0
mirror of https://github.com/mbierlee/mirage-config.git synced 2024-11-15 04:44:01 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Promote the Poodinis value injector in the Readme

Browse source
This commit is contained in:
Mike Bierlee 2022-11-27 21:47:36 +03:00
parent f76cf8699a
commit b9f1b253a6
1 changed files with 20 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -16,10 +16,13 @@ Features:
- Parse configuration from string or JSONValue instead of from disk.
## 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.
### Quickstart
```d
import std.stdio : writeln;
import mirage : loadConfig, parseJavaProperties;
@ -51,31 +54,38 @@ More formats are available (see [Formats](#formats).)
For more details and examples, see the [examples](examples) directory.
## Formats
The following file formats are currently supported:
| Format | Extension | Import<sup>*</sup> | Loader | Parser | Factory |
|-------------|-------------|--------------------|---------------------------|---------------------------------|-------------------------|
| _any below_ | _any below_ | `mirage` | `loadConfig`<sup>**</sup> | _(N/A)_ | |
| Format | Extension | Import<sup>\*</sup> | Loader | Parser | Factory |
| ----------- | ----------- | ------------------- | --------------------------- | ---------------------------------- | ----------------------- |
| _any below_ | _any below_ | `mirage` | `loadConfig`<sup>\*\*</sup> | _(N/A)_ | |
| INI | .ini | `mirage.ini` | `loadIniConfig` | `parseIniConfig` | `IniConfigFactory` |
| Java | .properties | `mirage.java` | `loadJavaProperties` | `parseJavaProperties` | `JavaPropertiesFactory` |
| JSON | .json | `mirage.json` | `loadJsonConfig` | `parseJsonConfig`<sup>***</sup> | `JsonConfigFactory` |
| JSON | .json | `mirage.json` | `loadJsonConfig` | `parseJsonConfig`<sup>\*\*\*</sup> | `JsonConfigFactory` |
<sup>\*</sup> _Any loader or parser can be imported from the `mirage` package since they are all publicly imported._
<sup>\*\*</sup> _Loads files based on their extension. If the file does not use one of the extensions in the table, you must use a specific loader._
<sup>\*\*\*</sup> _Besides parsing strings like the other formats, it also accepts a `JSONValue`._
Documentation
-------------
## Documentation
You can generate documentation from the source code using DUB:
```
dub build --build=ddox
```
The documentation can then be found in docs/
## History
For a full overview of changes, see [CHANGES.md](CHANGES.md)
## Poodinis Value Injector
Are you using the [Poodinis Dependency Injection framework](https://github.com/mbierlee/poodinis)? A value injector is available at [this](https://github.com/mbierlee/poodinis-mirage-config-injector) repository. See the README on how to use it.
## Contributing
Any and all pull requests are welcome! If you (only) want discuss changes before making them, feel free to open an Issue on github. Please develop your changes on (a branch based on) the develop branch. Continuous integration is preferred so feature branches are not neccessary.