From b6943d3382f99625d26d093def2645c94433b194 Mon Sep 17 00:00:00 2001
From: Csaba Kiraly <csaba.kiraly@gmail.com>
Date: Wed, 16 Feb 2022 11:30:06 +0100
Subject: [PATCH] adding minimal readme

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a74f40b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# A DHT implementation for Dagger
+
+This DHT implementation is aiming to provide a DHT for Dagger with the following properties
+* flexible transport usage with
+  * fast UDP based operation
+  * fallback to TCP-based operation (maybe though libp2p)
+  * support operation on top of libp2p
+* flexible message encoding that plays well with the above transports
+* provide node lookup, content storage/lookup, and provider storage/lookup operations
+  * roughly follow the libp2p-dht specifications from https://github.com/libp2p/specs/tree/master/kad-dht
+  * provide compatibility mode with the above specs
+
+Current implementation is based on nim-eth's Discovery v5 implementation. Base files were copied
+from nim-eth@779d767b024175a51cf74c79ec7513301ebe2f46
\ No newline at end of file