Merge pull request #18 from taylorjdawson/feature/refferal-link

Adds referral option
ProjectOpenSea · Mar 8, 2021 · 805eb8a · 805eb8a
2 parents 1700a4f + c3b1845
commit 805eb8a
Show file tree

Hide file tree

Showing 9 changed files with 9,115 additions and 12,283 deletions.
diff --git a/README.md b/README.md
@@ -1,44 +1,56 @@
+<img style="border-radius: 8px" src="assets/embedable-nfts.png" />
+
+<br /><br />
+
 # Embeddable NFTs
+
 Easily embed OpenSea listings in your website!
 
 ### Component inputs
 
-`horizontal` - If this is present, the card will be rendered horizontally.
+`tokenAddress`\*- The token's contract address.
 
-`orientationMode` - If `auto` the card will switch to vertical 
+`tokenId`\* - The token Id of the asset.
+
+`horizontal` - If this is present, the card will be rendered horizontally.
 mode on mobile (breakpoint is at 600px). In `manual` mode the card will be unaffected.
 
+`orientationMode` - If `auto` the card will switch to vertical
+
 `width` - The width of the embeddable. Ex. values `100%` `250px`. Default: `388px`
 
 `height` - The height of the embeddable. Ex. values `40vh` `300px`. Default: `560px`
 
-`tokenAddress`\*- The token's contract address.
-
-`tokenId`\* - The token Id of the asset.
-
 `network` - The name of the network the asset is on `mainnet` or `rinkeby`. Default: `mainnet`.
 
+`referrerAddress` - The address of the referrer. Check out the [SDK docs](https://github.com/ProjectOpenSea/opensea-js#affiliate-program) to learn more about the Affiliate program.
+
 \*Required inputs
 
 ### Usage
 
 Add this to your `<head>` tag:
+
 ```
 <script src="https://unpkg.com/embeddable-nfts/dist/nft-card.min.js"></script>
 ```
 
 Then add this into your code:
+
 ```
 <nft-card
   tokenAddress="0x5caebd3b32e210e85ce3e9d51638b9c445481567"
   tokenId="2242579050293992223"
   network="mainnet"
+  referrerAddress="YOUR_ADDRESS_HERE"
   >
 </nft-card>
 ```
 
 ### Development
+
 For developers looking to contribute or modify the code, or view the example use the following commands:
+
 ```bash
   git clone https://github.com/ProjectOpenSea/embeddable_nfts.git
   cd embeddable_nfts
@@ -47,4 +59,5 @@ For developers looking to contribute or modify the code, or view the example use
 ```
 
 #### Development server
+
 This project uses webpack for building and running a development server. Once the server starts, any changes made will trigger a rebuild after which those changes should be reflected in your browser.
diff --git a/assets/embedable-nfts.png b/assets/embedable-nfts.png
diff --git a/dist/nft-card.min.js b/dist/nft-card.min.js
diff --git a/dist/nft-card.min.js.map b/dist/nft-card.min.js.map