Add a README, ignore files we do not care about.

jlouis · Jun 14, 2014 · aa1645f · aa1645f
1 parent d0cce5c
commit aa1645f
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
 *.beam
 deps/
 ebin/*.app
+.dht_bt.plt
+src/dialyzer.out
diff --git a/README.md b/README.md
@@ -0,0 +1,8 @@
+# dht — Distributed Hash Table for Erlang
+
+The `dht` application implements a Distributed Hash Table for Erlang. It is hashed from teh etorrent application in order to make it possible to use it without using rest of etorrent.
+
+The current state of the code is that it is not ready yet:
+
+* We need to remove `etorrent_…` references from the code base.
+* We need to read through the code and rewrite parts of it when necessary.