34
34
## Table of Contents
35
35
36
36
- [ Credits] ( #credits )
37
- - [ How to install] ( #how-to-install )
38
- - [ How it works] ( #how-it-works )
39
- - [ How to use] ( #how-to-use )
37
+ - [ Documentation] ( #Documentation )
40
38
- [ Roadmap] ( #roadmap )
41
39
- [ Contributing] ( #contributing )
42
40
- [ License] ( #license )
45
43
46
44
[ ![ GitHub Contributors Image] ( https://contrib.rocks/image?repo=olivmath/merkly )] ( https://github.com/olivmath/merkly/graphs/contributors )
47
45
48
- ## How to install
46
+ ## Documentation
47
+
48
+ ** HOW TO INSTALL**
49
49
50
50
```
51
51
poetry add merkly
@@ -55,9 +55,18 @@ poetry add merkly
55
55
pip install merkly
56
56
```
57
57
58
- ## How to works
58
+ ** HOW TO WORKS**
59
+
60
+ <div style =" background-color : yellow ; padding : 10px ; border-left : 6px solid red ;" >
61
+ <strong >Atenção!</strong > Este é um alerta importante.
62
+ </div >
63
+
64
+ > ** Nota:** Este é um alerta ou nota importante.
65
+
66
+ !!! warning "Atenção"
67
+ Este é um alerta importante.
59
68
60
- - _ We use keccak-256 under-the-hood if you dont pass your hash function _
69
+ - ` We use keccak-256 under-the-hood if you dont pass your hash function `
61
70
62
71
This library provides a clean and easy to use implementation of the Merkle Tree with the following features:
63
72
@@ -66,7 +75,7 @@ This library provides a clean and easy to use implementation of the Merkle Tree
66
75
- Create Proof
67
76
- Verify Proof
68
77
69
- ## How to Use
78
+ ** HOW TO USE **
70
79
71
80
** Create a Merkle Tree**
72
81
@@ -163,20 +172,20 @@ assert mtree.verify(p, 'b') == True
163
172
164
173
## Roadmap
165
174
166
- | Feature | Status | Version |
167
- | ------------------------------------- | -------------- | ------- |
168
- | Auto deploy PyPi | ✅ Deployed | 0.2.0 |
169
- | Create Root | ✅ Deployed | 0.4.0 |
170
- | Create Proof | ✅ Deployed | 0.5.0 |
171
- | Verify Proof | ✅ Deployed | 0.6.0 |
172
- | Use any Hash function | ✅ Deployed | 0.7.0 |
173
- | Leafs of any size | ✅ Deployed | 0.8.0 |
174
- | Security deprecation pysha3 | ✅ Deployed | 0.8.1 |
175
- | Compatible with MerkleTreeJs | ✅ Deployed | 1.0.0 |
176
- | First Issue solved by community | ✅ Deployed | 1.0.0 |
177
- | Accelerator code with Rust | 🏗️ Alpha | 1.1.0 |
178
- | Tutorial how to use with solidity | 🖊️ Design | x.x.x |
179
- | Tutorial how to use with MerkleTreeJS | 🖊️ Design | x.x.x |
175
+ | Feature | Status | Version |
176
+ | ------------------------------------- | ----------- | ------- |
177
+ | Auto deploy PyPi | ✅ Deployed | 0.2.0 |
178
+ | Create Root | ✅ Deployed | 0.4.0 |
179
+ | Create Proof | ✅ Deployed | 0.5.0 |
180
+ | Verify Proof | ✅ Deployed | 0.6.0 |
181
+ | Use any Hash function | ✅ Deployed | 0.7.0 |
182
+ | Leafs of any size | ✅ Deployed | 0.8.0 |
183
+ | Security deprecation pysha3 | ✅ Deployed | 0.8.1 |
184
+ | Compatible with MerkleTreeJs | ✅ Deployed | 1.0.0 |
185
+ | First Issue solved by community | ✅ Deployed | 1.0.0 |
186
+ | Accelerator code with Rust | 🏗️ Alpha | 1.1.0 |
187
+ | Tutorial how to use with solidity | 🖊️ Design | x.x.x |
188
+ | Tutorial how to use with MerkleTreeJS | 🖊️ Design | x.x.x |
180
189
181
190
## Contributing
182
191
0 commit comments