aboutsummaryrefslogtreecommitdiffstats
path: root/packages/connect/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'packages/connect/README.md')
-rw-r--r--packages/connect/README.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/packages/connect/README.md b/packages/connect/README.md
index 900045526..63faf5271 100644
--- a/packages/connect/README.md
+++ b/packages/connect/README.md
@@ -1 +1,52 @@
+## @0xproject/connect
+
This repository contains 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)
+
+## Installation
+
+```bash
+yarn add @0xproject/connect
+```
+
+## Usage
+
+* [Docs](https://0xproject.com/docs/connect)
+* [Tutorials](https://0xproject.com/wiki#connect)
+
+## Contributing
+
+We strongly recommend that the community help us make improvements and determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository.
+
+Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.
+
+### Install Dependencies
+
+If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
+
+```bash
+yarn config set workspaces-experimental true
+```
+
+Then install dependencies
+
+```bash
+yarn install
+```
+
+### Build
+
+```bash
+yarn build
+```
+
+### Lint
+
+```bash
+yarn lint
+```
+
+### Run Tests
+
+```bash
+yarn test
+```