From 521f4123dd27202307dc409ed071c07330aab34b Mon Sep 17 00:00:00 2001 From: Mohammed Date: Mon, 1 May 2023 16:07:34 +0100 Subject: [PATCH] chore: improve npm and dev readmes --- README.md | 5 +++-- dev/README.md | 11 +++++++++++ 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a6da14e..f78c7f9 100644 --- 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 index df01751..a10b71b 100644 --- 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 ``` \ No newline at end of file