Update README.md

pH14 · Mar 7, 2019 · 7738a4e · 7738a4e
1 parent 6a7cec0
commit 7738a4e
Showing 1 changed file with 55 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,55 @@
-# fdb-zk
-ZooKeeper server on top of FoundationDB
+## fdb-zk
+
+`fdb-zk` is a FoundationDB layer that mimics the behavior of Zookeeper. It is installed as a local service to an application, and replaces connections to and the operation of a ZooKeeper cluster.
+
+#### Architecture
+
+Similar to the [FoundationDB Document Layer](https://foundationdb.github.io/fdb-document-layer/), `fdb-zk` is hosted locally and translates requests for the target service into FoundationDB transactions.
+
+Applications can continue to use their preferred `Zookeeper` clients:
+
+```
+┌──────────────────────┐     ┌──────────────────────┐
+│ ┌──────────────────┐ │     │ ┌──────────────────┐ │
+│ │   Application    │ │     │ │   Application    │ │
+│ └──────────────────┘ │     │ └──────────────────┘ │
+│           │          │     │           │          │
+│           │          │     │           │          │
+│       ZooKeeper      │     │       ZooKeeper      │
+│        protocol      │     │        protocol      │
+│           │          │     │           │          │
+│           │          │     │           │          │
+│           ▼          │     │           ▼          │
+│ ┌──────────────────┐ │     │ ┌──────────────────┐ │
+│ │  fdb-zk service  │ │     │ │  fdb-zk service  │ │
+│ └──────────────────┘ │     │ └──────────────────┘ │
+└──────────────────────┘     └──────────────────────┘
+            │                            │
+         FDB ops                      FDB ops
+            │                            │
+            ▼                            ▼
+┌───────────────────────────────────────────────────┐
+│                   FoundationDB                    │
+└───────────────────────────────────────────────────┘
+```
+
+### Features
+
+`fdb-zk` implements the core Zookeeper 3.4.6 API:
+
+* `create`
+* `exists`
+* `delete`
+* `getData`
+* `setData`
+* `getChildren`
+
+TODO:
+- [ ] `multi`
+- [ ] `getACL`
+- [ ] `setACL`
+
+
+### License
+
+`fdb-zk` is under the Apache 2.0 license. See the [LICENSE](LICENSE) file for details.