diff --git a/README.md b/README.md index 3a2d79c..e7b36ad 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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. diff --git a/package.json b/package.json index 6b68654..9517ba1 100644 --- a/package.json +++ b/package.json @@ -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", diff --git a/src/.eslintrc.js b/src/.eslintrc.js deleted file mode 100644 index d732584..0000000 --- a/src/.eslintrc.js +++ /dev/null @@ -1,5 +0,0 @@ -module.exports = { - rules: { - '@typescript-eslint/no-var-requires': 0, - } -} \ No newline at end of file