README: add supported formats (#66)

bpierre · May 11, 2021 · bea125f · bea125f
1 parent c2c0ff5
commit bea125f
Showing 1 changed file with 27 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -60,6 +60,33 @@ function Nft() {
 }
 ```
 
+## Supported NFT formats
+
+Any standard NFT ([EIP 721](https://eips.ethereum.org/EIPS/eip-721) or [EIP 1155](https://eips.ethereum.org/EIPS/eip-1155)) is, in theory supported by useNft(). In practice, some adjustments are needed to support some NFT formats, either because their implementation doesn’t follow the specification or because some parts of the specifications can be interpreted in different ways.
+
+This table keeps track of the NFT minting services that have been tested with useNft() and the adaptations needed.
+
+| NFT minting service                                  | Supported | Specific adaptations done by useNft()                                 |
+| ---------------------------------------------------- | --------- | --------------------------------------------------------------------- |
+| [AITO](https://www.thisisaito.xyz/)                  | Yes       |                                                                       |
+| [Async Art](https://async.art/)                      | Yes       |                                                                       |
+| [Clovers](https://clovers.network/)                  | Yes       |                                                                       |
+| [CryptoKitties](https://www.cryptokitties.co/)       | Yes       | Non standard NFT, dedicated mechanism.                                |
+| [CryptoPunks](https://www.larvalabs.com/cryptopunks) | Yes       | Non standard NFT, dedicated mechanism.                                |
+| [Cryptovoxels](https://www.cryptovoxels.com/)        | Yes       |                                                                       |
+| [Decentraland ](https://decentraland.org/)           | Partially | Parcels require a fix (not implemented yet). Wearables are supported. |
+| [Foundation](https://foundation.app/)                | Yes       |                                                                       |
+| [KnownOrigin](https://knownorigin.io/)               | Yes       |                                                                       |
+| [MakersPlace](https://makersplace.com/)              | Yes       | Incorrect JSON format (uses `imageUrl` instead of `image`).           |
+| [MoonCats](https://mooncatrescue.com/)               | Yes       | Non standard NFT, dedicated mechanism.                                |
+| [Nifty Gateway](https://niftygateway.com/)           | Yes       | Incorrect metadata URL.                                               |
+| [OpenSea](https://opensea.io/)                       | Yes       | Incorrect metadata URL.                                               |
+| [Portion.io](https://app.portion.io/)                | Yes       | Non-standard JSON format.                                             |
+| [Rarible](https://rarible.com/)                      | Yes       |                                                                       |
+| [SuperRare](https://superrare.co/)                   | Yes       |                                                                       |
+| [Uniswap V3](https://uniswap.org/)                   | Yes       |                                                                       |
+| [Zora](https://zora.co/)                             | Yes       |                                                                       |
+
 ## API
 
 ### useNft(contract: string, tokenId: string): NftResult