Add right README

daviddias · daviddias · commit 0928dc997960 · 2015-08-25T23:23:47.000+01:00
diff --git a/README.md b/README.md
@@ -1 +1,39 @@
-git@github.com:ipfs/node-ipfs-old.git
+node-ipfs
+=========
+
+> IPFS Node.js entry point and implementation roadmap
+
+# Description
+
+This repo (will) contains the entry point for the Node.js implementation of IPFS spec, similar to go-ipfs. It also presents the roadmap a modules of node-ipfs and their current state.
+
+
+# Usage
+
+> Not ready for prime time yet
+
+# Roadmap
+
+- Network
+  - [ ] libp2p
+    - [ ] Peer Routing
+      - [x] kad-routing
+        - discovery mechanisms
+          - [x] mDNS-discovery (https://github.com/diasdavid/node-ipfs-mdns)
+          - [ ] random-walk (https://github.com/diasdavid/node-ipfs-random-walk)
+          - [x] bootstrap-list (https://github.com/diasdavid/node-ipfs-railing)
+      - [ ] mDNS-routing
+    - [x] swarm (https://github.com/diasdavid/node-ipfs-swarm)
+      - [x] stream muxer (https://github.com/diasdavid/node-spdy-stream-muxer)
+      - [x] protocol muxer (https://github.com/diasdavid/node-multistream
+      - [x] Identify (https://github.com/diasdavid/node-ipfs-swarm/tree/master/src/identify)
+    - [ ] Distributed Record Store
+      - [ ] record (needs MerkleDAG node)
+      - [ ] distributed record store
+      - [ ] kad-record-store
+      - [ ] abstract-record-store
+- Exchange
+  - [ ] bitswap
+- MerkleDAG
+  - [ ] MerkleDAG node implementation (needs IPLD)
+
