From dea30b37efadc6a961a4b6ce140d19d851b09f13 Mon Sep 17 00:00:00 2001
From: Lawrence Forman <lawrence@0xproject.com>
Date: Sat, 16 Nov 2019 14:51:41 -0500
Subject: [PATCH] `@0x/contracts-erc20-bridge-sampler`: Update README and add
 `index.ts`.

---
 contracts/erc20-bridge-sampler/README.md    | 64 ++++++++++++++++++++-
 contracts/erc20-bridge-sampler/src/index.ts |  2 +
 2 files changed, 65 insertions(+), 1 deletion(-)
 create mode 100644 contracts/erc20-bridge-sampler/src/index.ts

diff --git a/contracts/erc20-bridge-sampler/README.md b/contracts/erc20-bridge-sampler/README.md
index 75017ed771..3a04e3b8bd 100644
--- a/contracts/erc20-bridge-sampler/README.md
+++ b/contracts/erc20-bridge-sampler/README.md
@@ -1,5 +1,67 @@
 ## ERC20BridgeSampler
 
-These contracts are used in DEX aggregation.
+This package contains contracts used in DEX aggregation.
 
 This is an MVP implementation, which agnostically samples DEXes for off-chain sorting and order generation. It is entirely read-only and never not touches any funds.
+
+## Installation
+
+**Install**
+
+```bash
+npm install @0x/contracts-erc20-bridge-sampler --save
+```
+
+## 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.
+
+For proposals regarding the 0x protocol's smart contract architecture, message format, or additional functionality, go to the [0x Improvement Proposals (ZEIPs)](https://github.com/0xProject/ZEIPs) repository and follow the contribution guidelines provided therein.
+
+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
+
+To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:
+
+```bash
+PKG=@0x/contracts-erc20-bridge-sampler yarn build
+```
+
+Or continuously rebuild on change:
+
+```bash
+PKG=@0x/contracts-erc20-bridge-sampler yarn watch
+```
+
+### Clean
+
+```bash
+yarn clean
+```
+
+### Lint
+
+```bash
+yarn lint
+```
+
+### Run Tests
+
+```bash
+yarn test
+```
diff --git a/contracts/erc20-bridge-sampler/src/index.ts b/contracts/erc20-bridge-sampler/src/index.ts
new file mode 100644
index 0000000000..91dd7e0e3e
--- /dev/null
+++ b/contracts/erc20-bridge-sampler/src/index.ts
@@ -0,0 +1,2 @@
+export * from './wrappers';
+export * from './artifacts';