docs: Update Readme Example to v1.2.0 with MerkleTree.Crypto and Proof

yosriady · Jan 27, 2018 · 5b19abd · 5b19abd
1 parent 37a6569
commit 5b19abd
Showing 1 changed file with 74 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -6,33 +6,87 @@ Merkle Tree implementation in pure Elixir.
 [![Coveralls](https://img.shields.io/coveralls/yosriady/merkle_tree.svg?maxAge=2592000)](https://coveralls.io/github/yosriady/merkle_tree)
 [![Hex.pm](https://img.shields.io/hexpm/v/merkle_tree.svg?maxAge=2592000)](https://hex.pm/packages/merkle_tree)
 
-### [Hex](http://hex.pm/packages/merkle_tree)
+### [Hex (Package Manager)](http://hex.pm/packages/merkle_tree)
 ### [API Documentation](https://hexdocs.pm/merkle_tree/)
 
 ## Installation
 
-Add `merkle_tree` to your list of dependencies in `mix.exs`:
+* Install the [Elixir](https://elixir-lang.org/) functional language.
 
-```elixir
-def deps do
-  [{:merkle_tree, "~> 1.1.1"}]
-end
-```
+* Create New Project with Mix
+  ```bash
+  mix new my_app; cd my_app
+  ```
+
+* Add `merkle_tree` to your list of dependencies in `mix.exs`. Note that merkle_tree v1.2.0 is required in order to use `MerkleTree.Proof`.
+  ```elixir
+  def deps do
+    [{:merkle_tree, "~> 1.2.0"}]
+  end
+  ```
+
+* Install Mix Dependencies
+  ```bash
+  mix deps.get
+  ```
 
 ## Usage
 
-```elixir
-iex> f = MerkleTree.new ['a', 'b', 'c', 'd']
-%MerkleTree{blocks: ['a', 'b', 'c', 'd'], hash_function: &MerkleTree.Crypto.sha256/1,
-      root: %MerkleTree.Node{children: [%MerkleTree.Node{children: [%MerkleTree.Node{children: [],
-           value: "ca978112ca1bbdcafac231b39a23dc4da786eff8147c4e72b9807785afee48bb"},
-          %MerkleTree.Node{children: [], value: "3e23e8160039594a33894f6564e1b1348bbd7a0088d42c4acb73eeaed59c009d"}],
-         value: "62af5c3cb8da3e4f25061e829ebeea5c7513c54949115b1acc225930a90154da"},
-        %MerkleTree.Node{children: [%MerkleTree.Node{children: [], value: "2e7d2c03a9507ae265ecf5b5356885a53393a2029d241394997265a1a25aefc6"},
-          %MerkleTree.Node{children: [], value: "18ac3e7343f016890c510e93f935261169d9e3f565436429830faf0934f4f8e4"}],
-         value: "d3a0f1c792ccf7f1708d5422696263e35755a86917ea76ef9242bd4a8cf4891a"}],
-       value: "58c89d709329eb37285837b042ab6ff72c7c8f74de0446b091b6a0131c102cfd"}}
-```
+* Run [Interactive Elixir (IEx)](https://hexdocs.pm/iex/IEx.html) within context of Elixir app and dependencies injected into IEx runtime
+  ```bash
+  iex -S mix
+  ```
+
+* Try the [MerkleTree Module](https://hexdocs.pm/merkle_tree/MerkleTree.html)
+  ```elixir
+  iex> MerkleTree.__info__(:functions)
+  [__struct__: 0, __struct__: 1, build: 2, new: 1, new: 2]
+  iex> mt = MerkleTree.new ['a', 'b', 'c', 'd']
+  %MerkleTree{blocks: ['a', 'b', 'c', 'd'], hash_function: &MerkleTree.Crypto.sha256/1,
+        root: %MerkleTree.Node{children: [%MerkleTree.Node{children: [%MerkleTree.Node{children: [],
+            value: "ca978112ca1bbdcafac231b39a23dc4da786eff8147c4e72b9807785afee48bb"},
+            %MerkleTree.Node{children: [], value: "3e23e8160039594a33894f6564e1b1348bbd7a0088d42c4acb73eeaed59c009d"}],
+          value: "62af5c3cb8da3e4f25061e829ebeea5c7513c54949115b1acc225930a90154da"},
+          %MerkleTree.Node{children: [%MerkleTree.Node{children: [], value: "2e7d2c03a9507ae265ecf5b5356885a53393a2029d241394997265a1a25aefc6"},
+            %MerkleTree.Node{children: [], value: "18ac3e7343f016890c510e93f935261169d9e3f565436429830faf0934f4f8e4"}],
+          value: "d3a0f1c792ccf7f1708d5422696263e35755a86917ea76ef9242bd4a8cf4891a"}],
+        value: "58c89d709329eb37285837b042ab6ff72c7c8f74de0446b091b6a0131c102cfd"}}
+  $ mt.blocks()
+  ['a', 'b', 'c', 'd'] 
+  $ mt.hash_function()
+  &MerkleTree.Crypto.sha256/1
+  $ mt.root()
+  ...
+  ```
+
+* Try the [MerkleTree.Proof Module](https://hexdocs.pm/merkle_tree/MerkleTree.Proof.html) (requires merkle_tree >1.2.0)
+  ```elixir
+  iex> MerkleTree.Proof.__info__(:functions)           
+  [__struct__: 0, __struct__: 1, prove: 2, proven?: 3]
+  iex> proof1 = MerkleTree.Proof.prove(mt, 1)
+  iex> proven1 = MerkleTree.Proof.proven?({"b", 1}, "58c89d709329eb37285837b042ab6ff72c7c8f74de0446b091b6a0131c102cfd", proof1)
+  true
+
+  iex> proof3 = MerkleTree.Proof.prove(mt, 3)                                              %MerkleTree.Proof{          
+    hash_function: &MerkleTree.Crypto.sha256/1,
+    hashes: ["62af5c3cb8da3e4f25061e829ebeea5c7513c54949115b1acc225930a90154da",
+    "2e7d2c03a9507ae265ecf5b5356885a53393a2029d241394997265a1a25aefc6"]
+  }
+  iex> proven3 = MerkleTree.Proof.proven?({"d", 3}, "58c89d709329eb37285837b042ab6ff72c7c8f74de0446b091b6a0131c102cfd", proof3)
+  true
+  ```
+
+* Try the [MerkleTree.Crypto Module](https://hexdocs.pm/merkle_tree/MerkleTree.Crypto.html)
+  ```elixir
+  iex> MerkleTree.Crypto.__info__(:functions) 
+  [hash: 2, sha256: 1]
+  iex> MerkleTree.Crypto.hash("tendermint", :sha256) 
+"f6c3848fc2ab9188dd2c563828019be7cee4e269f5438c19f5173f79898e9ee6"
+  iex> MerkleTree.Crypto.hash("tendermint", :md5)   
+"bc93700bdf1d47ad28654ad93611941f"
+  iex> MerkleTree.Crypto.sha256("tendermint")    
+"f6c3848fc2ab9188dd2c563828019be7cee4e269f5438c19f5173f79898e9ee6"
+  ```
 
 ## Background
 
@@ -44,7 +98,7 @@ Hash trees can be used to verify any kind of data stored, handled and transferre
 
 ## Running Type Checker
 
-```
+```bash
 mix dialyzer
 ```