diff options
Diffstat (limited to 'packages/website/md/docs/connect')
| -rw-r--r-- | packages/website/md/docs/connect/installation.md | 15 | ||||
| -rw-r--r-- | packages/website/md/docs/connect/introduction.md | 1 |
2 files changed, 16 insertions, 0 deletions
diff --git a/packages/website/md/docs/connect/installation.md b/packages/website/md/docs/connect/installation.md new file mode 100644 index 000000000..2d3755352 --- /dev/null +++ b/packages/website/md/docs/connect/installation.md @@ -0,0 +1,15 @@ +**Install** + +```bash +npm install @0xproject/connect --save +``` + +**Import** + +```javascript +import {HttpRelayerClient} from '@0xproject/connect'; +``` + +### Wiki + +Check out our [@0xproject/connect introduction tutorial](https://0xproject.com/wiki#Intro-Tutorial:Connect) for articles on how to get 0x.js setup with TestRPC, Infura and more! diff --git a/packages/website/md/docs/connect/introduction.md b/packages/website/md/docs/connect/introduction.md new file mode 100644 index 000000000..9b49cafff --- /dev/null +++ b/packages/website/md/docs/connect/introduction.md @@ -0,0 +1 @@ +Welcome to the [@0xproject/connect](https://github.com/0xProject/0x.js/tree/development/packages/connect) documentation! @0xproject/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 token pairs from a relayer, getting orders filtered by different attributes, getting individual orders specified by order hash, getting orderbooks for specific token pairs, getting fee information, and submitting orders. |