chore: improve npm and dev readmes

mohammed-almujil · May 1, 2023 · 521f412 · 521f412
1 parent 8151f41
commit 521f412
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,10 @@
-Import library 
+Get on-chain NFT mints/transfers/burns including their metadata.
 
+# Get started
 ```
 import * as onChainNFT  from 'on-chain-nfts'
 ```
-# ETH
+## ETH
 Set ETH provider
 ```
 onChainNFT.setEthProvider(process.env.PROVIDER_URL);

diff --git a/dev/README.md b/dev/README.md
@@ -50,4 +50,15 @@ onChainNFT.setArweaveHostnames(['arweave.net']);
 Run tests locally, make sure PROVIDER_URL ENV variable is set then run
 ```
 ts-node test.ts
+```
+
+### **NPM publishing**
+
+Build
+```
+npm run build
+```
+Publish. Only files in the `dist` folder will be pushed
+```
+npm publish
 ```