Merge branch 'main' of https://github.com/Swertin/BulkNftBurnTool

readme.md

@@ -1,31 +1,41 @@
-Commands to install:
+# Tool Purpose
+This tool was created to utilize the burnNFT instruction released in the [Metaplex Token Metadata Standard v1.3](https://docs.metaplex.com/programs/token-metadata/changelog/v1.3). You can use it to burn a bulk list of NFTs, and reclaim funds locked up in token, metadata and edition accounts. Keep in mind, once a token is burned, it's gone forever.
 
-git clone https://github.com/Swertin/BulkNftBurnTool.git
+## Commands to install:
 
-cd BulkNftBurnTool
+`git clone https://github.com/Swertin/BulkNftBurnTool.git`
 
-Ensure you have the latest version of node.js
+`cd BulkNftBurnTool`
 
-To install dependencies with yarn:
+**Ensure you have the latest version of node.js**
 
-yarn
+*To install dependencies with yarn:*
 
-To install dependencies with npm:
+`yarn`
 
-npm i
+*To install dependencies with npm:*
 
+`npm i`
 
-To Setup:
+
+## To Setup:
 
 Make a copy of .env-example, and name it as: .env
 
-Export private key from Phantom, paste it directly into Treasury as "Treasury=pR1vA73KeYSd1237A..."
+In the .env file, <br/>
+Export your private key from Phantom.
+<br/>**Note: This private key has to be the owner of the nfts that are being burned, otherwise the transaction will fail**
+
+Paste the private key in the Treasury field of .env
+<br/>e.g. `Treasury=pR1vA73KeYSd1237A...`
 
-Paste your RPC directly into RPC as "RPC=https://quicknode..."
+Paste your RPC in the RPC field of .env. 
+<br/>e.g. `RPC=https://nodemonkey...`
 
-Get a json hashlist array of the nfts that you want to burn, paste it in line 145 after const hashlist =, e.g. "const hashlist = ["nftHash1","nftHash2", "nftHash3"];
+Get a json hashlist array of the nfts that you want to burn, paste it in [line 145](https://github.com/Swertin/BulkNftBurnTool/blob/6be3a264689dda2e3dddf9389fba43425647414d/index.js#L145) after const hashlist = ...
+<br/>e.g. `const hashlist = ["nftHash1","nftHash2", "nftHash3"];`
 
 
-To Run:
+## To Run:
 
-node index.js
+`node index.js`