From c55a84d9186d6cc52ad5dae01f303933bbb6805d Mon Sep 17 00:00:00 2001
From: Kagami Hiiragi <kagami@genshiken.org>
Date: Sun, 28 Dec 2014 19:59:57 +0300
Subject: [PATCH] Add info to readme

---
 README.md | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 79 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 92b18c0..2a25753 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,88 @@
 # bitmessage [![Build Status](https://travis-ci.org/bitchan/bitmessage.svg?branch=master)](https://travis-ci.org/bitchan/bitmessage)
 
-JavaScript Bitmessage library for both browserify and node.
+JavaScript Bitmessage library for both browserify and node. The goal of this project is to implement Bitmessage protocol v3 for both platforms at the maximum possible level (we still can't create TCP connections or listen for incoming connections in the Browser but Proof of work and crypto is fully doable).
+
+## References
+
+* [Project wiki](https://bitmessage.org/wiki/Main_Page)
+* [Protocol specification](https://bitmessage.org/wiki/Protocol_specification)
+* [Whitepaper](https://bitmessage.org/bitmessage.pdf)
+
+## Implementation details
+
+With the help of browserify `bitmessage` provides different implementations for Browser and Node.js with the same API. Because WebCryptoAPI defines asynchronous promise-driven API, implementation for Node needs to use promises too.
+
+* Use Node.js crypto module/library bindings where possible
+* Use WebCryptoAPI where possible
+* Promise-driven API
+
+## Feature matrix (both Browser and Node)
+
+- [ ] crypto
+  - [x] SHA-512
+  - [x] SHA-256
+  - [x] RIPEMD-160
+  - [x] PRNG
+  - [x] ECC keys manipulation
+  - [x] ECDSA
+  - [ ] ECDH
+  - [ ] ECIES
+  - [ ] AES-256-CBC
+  - [ ] HMAC-SHA-256
+- [ ] Core structures
+  - [x] var_int
+    - [x] encode
+    - [x] decode
+  - [ ] var_str
+    - [ ] encode
+    - [ ] decode
+  - [ ] var_int_list
+    - [ ] encode
+    - [ ] decode
+  - [ ] inv_vect
+    - [ ] encode
+    - [ ] decode
+  - [ ] net_addr
+    - [ ] encode
+    - [ ] decode
+  - [ ] bitfield
+    - [ ] encode
+    - [ ] decode
+- [ ] High-level objects
+  - [ ] Address
+    - [x] encode
+    - [x] decode
+    - [x] getRipe
+    - [x] getRandom
+    - [ ] getDeterministic
+  - [ ] Message
+    - [ ] encode
+    - [ ] decode
+- [ ] WIF
+  - [ ] encode
+  - [ ] decode
+- [ ] Parse PyBitmessage configs
+  - [ ] decode keys.dat
+  - [ ] decode knownnodes.dat
+  - [ ] decode messages.dat
+
+# Feature matrix (Node.js only)
+
+- [ ] Network
+  - [ ] Bootstrap
+  - [ ] Connect to the network
+  - [ ] Accept connections
 
 ## Usage
 
 ```js
-var bitmessage = require("bitmessage");
+var Address = require("bitmessage").Address;
+Address.getRandom().then(function(addr) {
+  Address.encode(addr).then(function(str) {
+    console.log("New random Bitmessage address:", str);
+    console.log("Private keys and parameters:", addr);
+  });
+});
 ```
 
 ## License