diff options
author | fragosti <francesco.agosti93@gmail.com> | 2018-08-24 08:17:45 +0800 |
---|---|---|
committer | fragosti <francesco.agosti93@gmail.com> | 2018-08-24 08:17:45 +0800 |
commit | 1040826b8b04d24e053c6afc21e69c4845151d2f (patch) | |
tree | d5282da9876c3d9a6b962f839ef6425c6f8180ff /packages/website | |
parent | 2c660e62d34bc59957c04a52fb43975470f009e7 (diff) | |
download | dexon-0x-contracts-1040826b8b04d24e053c6afc21e69c4845151d2f.tar.gz dexon-0x-contracts-1040826b8b04d24e053c6afc21e69c4845151d2f.tar.zst dexon-0x-contracts-1040826b8b04d24e053c6afc21e69c4845151d2f.zip |
Add documentation for connect v2
Diffstat (limited to 'packages/website')
-rw-r--r-- | packages/website/md/docs/connect/2.0.0/introduction.md | 3 | ||||
-rw-r--r-- | packages/website/ts/containers/connect_documentation.ts | 5 |
2 files changed, 8 insertions, 0 deletions
diff --git a/packages/website/md/docs/connect/2.0.0/introduction.md b/packages/website/md/docs/connect/2.0.0/introduction.md new file mode 100644 index 000000000..de7ece7ae --- /dev/null +++ b/packages/website/md/docs/connect/2.0.0/introduction.md @@ -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. diff --git a/packages/website/ts/containers/connect_documentation.ts b/packages/website/ts/containers/connect_documentation.ts index 8b13081c6..90137243c 100644 --- a/packages/website/ts/containers/connect_documentation.ts +++ b/packages/website/ts/containers/connect_documentation.ts @@ -10,6 +10,7 @@ import { Translate } from 'ts/utils/translate'; /* tslint:disable:no-var-requires */ 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'); /* tslint:enable:no-var-requires */ @@ -33,6 +34,10 @@ const docsInfoConfig: DocsInfoConfig = { [markdownSections.introduction]: IntroMarkdownV1, [markdownSections.installation]: InstallationMarkdownV1, }, + '2.0.0-rc.1': { + [markdownSections.introduction]: IntroMarkdownV2, + [markdownSections.installation]: InstallationMarkdownV1, + }, }, markdownSections, }; |