Skip to content

Commit

Permalink
Merge pull request #2 from RedChillies-Core/feat/readme_fix
Browse files Browse the repository at this point in the history
Fixed Readme
  • Loading branch information
GSaphal committed Dec 24, 2021
2 parents 3d6263d + e49ea03 commit 8df5802
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 20 deletions.
31 changes: 17 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ A Simple Javascript library to generate Merkle Tree and get its root and proof f

## Installation

The recommend way to use MetaMask React with a React app is to install it as a dependency:
The recommend way to use Merkle Tree Generator is to install it as a dependency:

```shell
# If you use npm:
Expand All @@ -23,19 +23,22 @@ import { generateTreeforBech32, generateTreeforBase16 } from 'merkle-tree-zilliq
```

2. The next step is to send a array of data to the generate tree function. The format of data should be:
[
{
wallet:"",
address:""
},
{
wallet:"",
address:""
},
.....
]

### The address should be in base16 for generateTreeforBase16 and bech32 for generateTreeforBase16.

```
[
{
wallet:"",
address:""
},
{
wallet:"",
address:""
},
.....
]
```

[ Note: The address should be in base16 for generateTreeforBase16 and bech32 for generateTreeforBase16.]

3. And boom, you are done! It returns you with the merkle root and proof for all the passed wallets, which can be passed on Smart Contracts for claiming the rewards.

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "merkle-tree-zilliqa-js",
"version": "1.0.1",
"version": "1.0.2",
"description": "A JS Library to generate the merkle tree and gets it's root and proof for any given distribution",
"main": "lib/index.js",
"types": "lib/index.d.ts",
Expand Down
5 changes: 0 additions & 5 deletions src/.eslintrc.js

This file was deleted.

0 comments on commit 8df5802

Please sign in to comment.