Skip to content

Commit 4f2ccac

Browse files
committed
update: docs WIP
1 parent 82ddc61 commit 4f2ccac

File tree

1 file changed

+30
-21
lines changed

1 file changed

+30
-21
lines changed

README.md

+30-21
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,7 @@
3434
## Table of Contents
3535

3636
- [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)
4038
- [Roadmap](#roadmap)
4139
- [Contributing](#contributing)
4240
- [License](#license)
@@ -45,7 +43,9 @@
4543

4644
[![GitHub Contributors Image](https://contrib.rocks/image?repo=olivmath/merkly)](https://github.com/olivmath/merkly/graphs/contributors)
4745

48-
## How to install
46+
## Documentation
47+
48+
**HOW TO INSTALL**
4949

5050
```
5151
poetry add merkly
@@ -55,9 +55,18 @@ poetry add merkly
5555
pip install merkly
5656
```
5757

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.
5968

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`
6170

6271
This library provides a clean and easy to use implementation of the Merkle Tree with the following features:
6372

@@ -66,7 +75,7 @@ This library provides a clean and easy to use implementation of the Merkle Tree
6675
- Create Proof
6776
- Verify Proof
6877

69-
## How to Use
78+
**HOW TO USE**
7079

7180
**Create a Merkle Tree**
7281

@@ -163,20 +172,20 @@ assert mtree.verify(p, 'b') == True
163172

164173
## Roadmap
165174

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 |
180189

181190
## Contributing
182191

0 commit comments

Comments
 (0)