From 449b2dc996522af6ff3379a772fc588314a300fc Mon Sep 17 00:00:00 2001 From: Erin Grasmick Date: Mon, 2 Sep 2024 17:25:07 +0100 Subject: [PATCH] update readme with json --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 8083d54..93a785f 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,20 @@ When minting NFTs, PolkaCLI allows you to include metadata and images, either di - If the `"image"` field is absent or empty, and you provide an image using `--image `, PolkaCLI will pin the specified image to IPFS and update the JSON file with the IPFS link. - If no image is provided via `--image`, PolkaCLI will attempt to infer the image filename based on the JSON file's name (e.g., `nft.json` -> `nft.jpg`). - If no image is found or provided, the minting process will fail. + +An example of valid NFT JSON is as follows: + +```json +{ + "animation_url": "", + "attributes": ["rare"], + "description": "a cool nft", + "external_url": "https://my.nft.shop", + "image": "ipfs://Qmf4ECDXU4g4GDhAQQQpu6QpiE7GHJmmDvxGR1AeF4Atq3", + "name": "Edition 1", + "type": "image/png" +} +``` - **--image ``**: - If the `--image` argument is provided, the specified image file is pinned to IPFS, and its link is added to the JSON file.