diff --git a/README.md b/README.md index 8da3c5c..b082a5f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ Configuration abstraction framework using Google Protocol Buffers, Spring and varous formatters # Concepts -Configuration framework is designed to provide separation between config consumption and aquisition. The `consumer` package provides interfaces that should be coded against by the application wishing to consume the config data. The data is returned in the form of Google Protocol Buffers `Message` objects which have been populated from various dedicated or augmenting sources (HTTP, Files, DB, etc) stored in various formats (XML, JSON, Properties, Protobuf Binary, etc). The `provider` package provides interfaces that should be coded against by the config data retrieval providers and formatters. The responsibility of actually interpreting the `ConfigParam` elements and deciding on where to load the actual config data from and what format conversion to use falls upon the jurisdiction of `ConfigProvider` implementations. +Configuration framework is designed to provide separation between config consumption and acquisition. The `consumer` package provides interfaces that should be coded against by the application wishing to consume the config data. The data is returned in the form of Google Protocol Buffers `Message` objects which have been populated from various dedicated or augmenting sources (HTTP, Files, DB, etc) stored in various formats (XML, JSON, Properties, Protobuf Binary, etc). The `provider` package provides interfaces that should be coded against by the config data retrieval providers and formatters. The responsibility of actually interpreting the `ConfigParam` elements and deciding on where to load the actual config data from and what format conversion to use falls upon the jurisdiction of `ConfigProvider` implementations. # Formats The framework uses [Protobuf Java Format](http://code.google.com/p/protobuf-java-format/) library for converting XML, JSON, Text and Properties files into Protocol Buffers Messages. `AbstractConfigProvider` provides a `convertMessage` function that is handling the conversion from the above-mentioned formats.