Skip to content

Commit

Permalink
update readme with json
Browse files Browse the repository at this point in the history
  • Loading branch information
lovelaced committed Sep 2, 2024
1 parent 3d4eee1 commit 449b2dc
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <image.jpg>`, 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 `<image.jpg>`**:
- If the `--image` argument is provided, the specified image file is pinned to IPFS, and its link is added to the JSON file.
Expand Down

0 comments on commit 449b2dc

Please sign in to comment.