From: Christopher <chris@entropealabs.com>
Date: Tue, 10 Mar 2020 01:19:05 +0000 (-0500)
Subject: update README
X-Git-Url: http://git.entropealabs.com/?a=commitdiff_plain;h=c274b77acb2711ac0c8a79253cb7870c606f7297;p=cluster_kv.git

update README
---

diff --git a/README.md b/README.md
index f4dcfea..2be0fdc 100644
--- a/README.md
+++ b/README.md
@@ -1,21 +1,26 @@
-# ClusterKv
+# ClusterKV
 
-**TODO: Add description**
+An ephemeral distributed KV store or [DHT](https://en.wikipedia.org/wiki/Distributed_hash_table)
 
-## Installation
+Backed by in-memory ETS table.
+
+Utilizes [libcluster](https://github.com/bitwalker/libcluster) for clustering 
+
+and [libring](https://github.com/bitwalker/libring) for the consistent hash ring.
 
-If [available in Hex](https://hex.pm/docs/publish), the package can be installed
-by adding `cluster_kv` to your list of dependencies in `mix.exs`:
+See [cluster_test](https://gitlab.com/entropealabs/cluster_test) for an example utilization
+
+Primarily built for use within a distributed WAMP Router. See [WAMPex](https://gitlab.com/entropealabs/wampex) for more information and [wamp-proto.org](https://wamp-proto.org/) for more information about the WAMP protocol
+
+## Installation
 
 ```elixir
 def deps do
   [
-    {:cluster_kv, "~> 0.1.0"}
+    {:cluster_kv, git: "https://gitlab.com/entropealabs/cluster_kv", tag: "e042a674095208de84a86c32239cecc9834d0177"}
   ]
 end
 ```
 
-Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
-and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
-be found at [https://hexdocs.pm/cluster_kv](https://hexdocs.pm/cluster_kv).
+Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc).