Add documentation for connect v2

This commit is contained in:
fragosti
2018-08-23 17:17:45 -07:00
parent 2c660e62d3
commit 1040826b8b
2 changed files with 8 additions and 0 deletions

View File

@@ -0,0 +1,3 @@
<b>**NOTE:** Release candidate versions are meant to work with V2 of the Standard Relayer API. To interact with V1, select a 1.X version of connect.</b>
Welcome to the [0x Connect](https://github.com/0xProject/0x-monorepo/tree/development/packages/connect) documentation! 0x Connect is a Javascript library that makes it easy to interact with relayers that conform to the [Standard Relayer API](https://github.com/0xProject/standard-relayer-api). Functionality includes getting supported asset pairs from a relayer, getting orders filtered by different attributes, getting individual orders specified by order hash, getting orderbooks for specific asset pairs, getting fee information, and submitting orders.

View File

@@ -10,6 +10,7 @@ import { Translate } from 'ts/utils/translate';
/* tslint:disable:no-var-requires */ /* tslint:disable:no-var-requires */
const IntroMarkdownV1 = require('md/docs/connect/1.0.0/introduction'); const IntroMarkdownV1 = require('md/docs/connect/1.0.0/introduction');
const IntroMarkdownV2 = require('md/docs/connect/2.0.0/introduction');
const InstallationMarkdownV1 = require('md/docs/connect/1.0.0/installation'); const InstallationMarkdownV1 = require('md/docs/connect/1.0.0/installation');
/* tslint:enable:no-var-requires */ /* tslint:enable:no-var-requires */
@@ -33,6 +34,10 @@ const docsInfoConfig: DocsInfoConfig = {
[markdownSections.introduction]: IntroMarkdownV1, [markdownSections.introduction]: IntroMarkdownV1,
[markdownSections.installation]: InstallationMarkdownV1, [markdownSections.installation]: InstallationMarkdownV1,
}, },
'2.0.0-rc.1': {
[markdownSections.introduction]: IntroMarkdownV2,
[markdownSections.installation]: InstallationMarkdownV1,
},
}, },
markdownSections, markdownSections,
}; };