From fe1ef930ad0febcf2b35f26da7d19123c881f741 Mon Sep 17 00:00:00 2001 From: Amir Bandeali Date: Tue, 22 Jan 2019 13:37:14 -0800 Subject: Update DEPLOYS and READMEs within each package --- contracts/exchange-forwarder/README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) (limited to 'contracts/exchange-forwarder/README.md') diff --git a/contracts/exchange-forwarder/README.md b/contracts/exchange-forwarder/README.md index 820f6e78a..3fc8c006b 100644 --- a/contracts/exchange-forwarder/README.md +++ b/contracts/exchange-forwarder/README.md @@ -1,10 +1,14 @@ -## Contract extensions +## Exchange Forwarder -Smart contracts that implement extensions for the 0x protocol. +This package contains the implementation of the [`Forwarder`](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/forwarder-specification.md) contract. This contract is intended to improve the UX of interacting with the 0x [`Exchange`](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md#exchange) contract by abstracting user approvals, converting ETH to WETH, and paying fees. Addresses of the deployed contracts can be found in the 0x [wiki](https://0xproject.com/wiki#Deployed-Addresses) or the [DEPLOYS](./DEPLOYS.json) file within this package. -## Usage +## Installation -Contract extensions of the protocol can be found in the [contracts](./contracts) directory. This directory contains contracts that interact with the 2.0.0 contracts and will be used in production, such as the [Forwarder](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/forwarder-specification.md) contract. +**Install** + +```bash +npm install @0x/contracts-exchange-forwarder --save +``` ## Bug bounty @@ -37,13 +41,13 @@ yarn install 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-extensions yarn build +PKG=@0x/contracts-exchange-forwarder yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0x/contracts-extensions yarn watch +PKG=@0x/contracts-exchange-forwarder yarn watch ``` ### Clean -- cgit v1.2.3