Add "How to implement" to README #31
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ronja-ui
reviewed
Jan 21, 2025
| @@ -19,6 +19,12 @@ CNF-01 is a library that provides immutable configuration for Java projects. Imm | |||
| . command line arguments (`ArgsConfiguration`) | |||
| - Default configurations in case the provided configurations from a source are not found or are otherwise broken (`DefaultConfiguration`) | |||
|
|
|||
| == A word about immutability | |||
ronja-ui
reviewed
Jan 21, 2025
| Follow these steps to implement CNF-01 in a Java project: | ||
|
|
||
| * Identify the object that has to use configurations. | ||
| * You can define an interface for the factory objects that create the configured objects: |
There was a problem hiding this comment.
Use list continuation with clode blocks: https://docs.asciidoctor.org/asciidoc/latest/lists/continuation/#list-continuation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added instructions on implementation to README. Similar to internal docs.