diff options
| author | Brandon Millman <brandon.millman@gmail.com> | 2018-10-23 06:33:55 +0800 |
|---|---|---|
| committer | Brandon Millman <brandon.millman@gmail.com> | 2018-10-23 06:33:55 +0800 |
| commit | 1ba207f1fef4338682b4cc7e45af8c073e63d263 (patch) | |
| tree | 395bc6caaf105a094688e2c753b7bd2d26c4ee8f /packages/website | |
| parent | be97eebe022739bf7f993d17eda7d26ad4ef448a (diff) | |
| download | dexon-sol-tools-1ba207f1fef4338682b4cc7e45af8c073e63d263.tar.gz dexon-sol-tools-1ba207f1fef4338682b4cc7e45af8c073e63d263.tar.zst dexon-sol-tools-1ba207f1fef4338682b4cc7e45af8c073e63d263.zip | |
fix(website): asset-buyer usage documentation formatting
Diffstat (limited to 'packages/website')
| -rw-r--r-- | packages/website/md/docs/asset_buyer/installation.md | 4 | ||||
| -rw-r--r-- | packages/website/md/docs/asset_buyer/usage.md | 6 |
2 files changed, 5 insertions, 5 deletions
diff --git a/packages/website/md/docs/asset_buyer/installation.md b/packages/website/md/docs/asset_buyer/installation.md index 76affaa09..3c0c95068 100644 --- a/packages/website/md/docs/asset_buyer/installation.md +++ b/packages/website/md/docs/asset_buyer/installation.md @@ -1,10 +1,10 @@ -**Install** +#### Install ```bash yarn add @0x/asset-buyer ``` -**Import** +#### Import ```javascript import { AssetBuyer } from '@0x/asset-buyer'; diff --git a/packages/website/md/docs/asset_buyer/usage.md b/packages/website/md/docs/asset_buyer/usage.md index 6462d938e..209c15062 100644 --- a/packages/website/md/docs/asset_buyer/usage.md +++ b/packages/website/md/docs/asset_buyer/usage.md @@ -1,4 +1,4 @@ -**Construction** +#### Construction Connecting to a standard relayer API compliant url: @@ -16,7 +16,7 @@ const orders = []; // get these from your own API, a relayer, a friend, from any const assetBuyer = AssetBuyer.getAssetBuyerForProvidedOrders(provider, orders); ``` -**Get a quote** +#### Get a quote A [BuyQuote](#types-BuyQuote) object contains enough information to display buy information to an end user @@ -30,7 +30,7 @@ console.log(quoteInfo.feeAmount); // a portion of the total ethAmount above that console.log(quoteInfo.ethPerAssetPrice); // the rate that this quote provides (e.g. 0.0035ETH / REP) ``` -**Perform a buy** +#### Perform a buy Pass the [BuyQuote](#types-BuyQuote) object from above back to the assetBuyer in order to initiate the buy transaction |