Skip to content

Commit

Permalink
Update README (#26)
Browse files Browse the repository at this point in the history
  • Loading branch information
51-code authored Nov 27, 2024
1 parent 1b07c20 commit b53836e
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,9 @@ CNF-01 is a library that provides immutable configuration for Java projects. Imm
. configuration files / path properties (`PathConfiguration`)
. System Properties (`PropertiesConfiguration`)
. environment variables (`EnvironmentConfiguration`)
. command line arguments (`ArgsConfiguration`)
- Default configurations in case the provided configurations from a source are not found or are otherwise broken (`DefaultConfiguration`)

== Limitations

// If your project has limitations, please list them. Otherwise remove this section.
All planned configuration sources are not yet supported.

== How to use

// add instructions how people can start to use your project
Expand Down Expand Up @@ -56,7 +52,7 @@ Map<String, String> configurationMap = defaultConfiguration.asMap();

=== Configuration objects in your project

The configuration Map from CNF-01 shouldn't be used directly in regular objects. It should only be passed to objects that are responsible for providing configured versions of other objects, in other words, Factories.
The configuration Map from CNF-01 shouldn't be used directly in regular objects. It should only be passed to objects that are responsible for providing configured versions of other objects, in other words, Factories. The regular objects must not be configurable!

Small example with an `Example` object:

Expand Down

0 comments on commit b53836e

Please sign in to comment.