Initial commit

[ta/config-manager.git] / cmframework / src / README

diff --git a/cmframework/src/README b/cmframework/src/README
new file mode 100644 (file)
index 0000000..b71c2de
--- /dev/null
+++ b/cmframework/src/README
@@ -0,0 +1,13 @@
+This project provides an implementation for a generic configuration management
+framework. The framework provides the following:
+* Interfaces for getting, setting or deleting of configuration data.
+* Interfaces for taking a backup of configuration data.
+* Interfaces for restoring the configuration data from a previously taken
+  backup.
+* A CLI for manipulating the configuration data.
+* A plugin based interface for validating the change in configuration data.
+* A plugin based interface for activating the change in configuration data.
+
+At the highlevel, the framework surves the following purposes:
+* Provides a unified interface for manipulating the configuration data.
+* Isolate the configuration management users from changes in the used backend.