X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=README.md;h=979d35e83d06cf6e2f3561355240cd95a2cda106;hb=refs%2Fchanges%2F31%2F22131%2F1;hp=1d1a1e8a0b4cf68a0088ec26954520d0154db028;hpb=1ea091379abc654e6d5f66320dc930877fb27ba8;p=apps%2Fagl-service-data-persistence.git

diff --git a/README.md b/README.md
index 1d1a1e8..979d35e 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,52 @@
-# agl-service-data-persistence
 
+# Database Binding
+
+This binding provide a database API with key/value semantics.
+The backend is currently a Berkeley DB.
+
+## Verbs
+
+* **insert**:
+
+    This verb insert a key/value pair in the database.
+    If the key already exist, the verb fails.
+
+* **update**:
+
+    This verb update an existing record.
+    If the key doesn't exist, the verb fails.
+
+* **delete**:
+
+    This verb remove an existing key/value pair from the database.
+    If no matching record is found, the verb fails.
+
+* **read**:
+
+    This verb get the value associated with the specified key.
+    If no matching record is found, the verb fails.
+
+## Arguments
+
+* The **read** and **delete** verbs need only a **key** to work:
+
+```code
+{
+    "key": "mykey"
+}
+```
+
+* The **insert** and **update** verbs need a **key** and a **value** to work:
+
+```code
+{
+    "key": "mykey",
+    "value": "my value"
+}
+```
+
+The **value** can be any valid json.
+
+## Dependencies
+
+You must install BerkeleyDB and GDBM
\ No newline at end of file