From 6be3a264689dda2e3dddf9389fba43425647414d Mon Sep 17 00:00:00 2001
From: Fawnzee <66336682+Swertin@users.noreply.github.com>
Date: Fri, 5 Aug 2022 12:34:52 -0700
Subject: [PATCH 1/2] Update readme.md
---
readme.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/readme.md b/readme.md
index 4b622ac..fe3a299 100644
--- a/readme.md
+++ b/readme.md
@@ -1,4 +1,4 @@
-Commands to install:
+#Commands to install:
git clone https://github.com/Swertin/BulkNftBurnTool.git
@@ -15,7 +15,7 @@ To install dependencies with npm:
npm i
-To Setup:
+#To Setup:
Make a copy of .env-example, and name it as: .env
@@ -26,6 +26,6 @@ Paste your RPC directly into RPC as "RPC=https://quicknode..."
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"];
-To Run:
+#To Run:
-node index.js
\ No newline at end of file
+node index.js
From 95fb76e70ede15d574cc9cdbb3a37148d0ec6780 Mon Sep 17 00:00:00 2001
From: Fawnzee <66336682+Swertin@users.noreply.github.com>
Date: Fri, 5 Aug 2022 12:57:12 -0700
Subject: [PATCH 2/2] Cleaned up readme, improved readability
---
readme.md | 38 ++++++++++++++++++++++++--------------
1 file changed, 24 insertions(+), 14 deletions(-)
diff --git a/readme.md b/readme.md
index fe3a299..b95e659 100644
--- a/readme.md
+++ b/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,
+Export your private key from Phantom.
+
**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
+
e.g. `Treasury=pR1vA73KeYSd1237A...`
-Paste your RPC directly into RPC as "RPC=https://quicknode..."
+Paste your RPC in the RPC field of .env.
+
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 = ...
+
e.g. `const hashlist = ["nftHash1","nftHash2", "nftHash3"];`
-#To Run:
+## To Run:
-node index.js
+`node index.js`