README.md: Update README

Reformat the README in markdown format, fix broken links and update repository information and description. Signed-off-by: Gordan Markuš <[email protected]>
GENIVI · Jul 5, 2017 · 98a32c6 · 98a32c6
1 parent eeac12c
commit 98a32c6
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 26 deletions.
diff --git a/README b/README
diff --git a/README.md b/README.md
@@ -0,0 +1,13 @@
+# GENIVI Persistence Common Object
+
+This is the official source of the GENIVI Persistence Common Object. At present, all relevant documentation for this project is available in the GENIVI wiki on: https://at.projects.genivi.org/wiki/display/PROJ/The+Persistence+Common+Object
+
+Master location for GENIVI Persistence Common Object: https://github.com/GENIVI/persistence-common-object
+
+## License
+
+For licensing information see the COPYING file, distributed along with this project.
+
+## Build Dependencies and Instructions
+
+The Persistence Common Object has dependencies on the DLT library, which is a part of the GENIVI/dlt-daemon (https://github.com/GENIVI/dlt-daemon). The Persistence Common Object specifies an API to access the key/value and configuration data of GENIVI's persistent data handling.