aboutsummaryrefslogtreecommitdiffstats
path: root/contracts/asset-proxy/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'contracts/asset-proxy/README.md')
-rw-r--r--contracts/asset-proxy/README.md19
1 files changed, 9 insertions, 10 deletions
diff --git a/contracts/asset-proxy/README.md b/contracts/asset-proxy/README.md
index dc1f32c98..48a5b20a5 100644
--- a/contracts/asset-proxy/README.md
+++ b/contracts/asset-proxy/README.md
@@ -1,15 +1,14 @@
-## Contracts
+## AssetProxy
-Smart contracts that implement the 0x protocol. Addresses of the deployed contracts can be found in the 0x [wiki](https://0xproject.com/wiki#Deployed-Addresses) or the [CHANGELOG](./CHANGELOG.json) of this package.
+This package contains the implementations of all of the [`AssetProxy`](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md#assetproxy) contracts available within the 0x protocol. These contracts are responsible for decoding the `assetData` sent to them and performing the actual transfer of assets. 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
-Contracts that make up and interact with version 2.0.0 of the protocol can be found in the [contracts](./contracts) directory. The contents of this directory are broken down into the following subdirectories:
+**Install**
-- [protocol](./contracts/protocol)
- - This directory contains the contracts that make up version 2.0.0. A full specification can be found [here](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md).
-- [test](./contracts/test)
- - This directory contains mocks and other contracts that are used solely for testing contracts within the other directories.
+```bash
+npm install @0x/contracts-asset-proxy --save
+```
## Bug bounty
@@ -42,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-protocol yarn build
+PKG=@0x/contracts-asset-proxy yarn build
```
Or continuously rebuild on change:
```bash
-PKG=@0x/contracts-protocol yarn watch
+PKG=@0x/contracts-asset-proxy yarn watch
```
### Clean