initial commit

[osm/common.git] / README.rst

diff --git a/README.rst b/README.rst
new file mode 100644 (file)
index 0000000..3273af4
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,11 @@
+===========
+osm-common
+===========
+
+Contains general modules for lightweight build database, storage and message access.
+The target is to use same library for OSM modules, in order to easy migration to other technologies, that is
+different database or storage object system.
+For database: mongo and memory (volatile) are implemented.
+For message: Kafka and local file system are implemented.
+For storage: only local file system is implemented.
+