aboutsummaryrefslogtreecommitdiffstats
path: root/contracts/extensions/README.md
diff options
context:
space:
mode:
authorAmir Bandeali <abandeali1@gmail.com>2019-01-23 05:37:14 +0800
committerAmir Bandeali <abandeali1@gmail.com>2019-01-23 05:37:14 +0800
commitfe1ef930ad0febcf2b35f26da7d19123c881f741 (patch)
tree24721707fafda1243586968a7867be7f75611e03 /contracts/extensions/README.md
parentab4d4a69ec105f1716cd705350441bb2d9ec4b87 (diff)
downloaddexon-0x-contracts-fe1ef930ad0febcf2b35f26da7d19123c881f741.tar
dexon-0x-contracts-fe1ef930ad0febcf2b35f26da7d19123c881f741.tar.gz
dexon-0x-contracts-fe1ef930ad0febcf2b35f26da7d19123c881f741.tar.bz2
dexon-0x-contracts-fe1ef930ad0febcf2b35f26da7d19123c881f741.tar.lz
dexon-0x-contracts-fe1ef930ad0febcf2b35f26da7d19123c881f741.tar.xz
dexon-0x-contracts-fe1ef930ad0febcf2b35f26da7d19123c881f741.tar.zst
dexon-0x-contracts-fe1ef930ad0febcf2b35f26da7d19123c881f741.zip
Update DEPLOYS and READMEs within each package
Diffstat (limited to 'contracts/extensions/README.md')
-rw-r--r--contracts/extensions/README.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/contracts/extensions/README.md b/contracts/extensions/README.md
index 820f6e78a..f1767869d 100644
--- a/contracts/extensions/README.md
+++ b/contracts/extensions/README.md
@@ -1,10 +1,14 @@
-## Contract extensions
+## Extensions
-Smart contracts that implement extensions for the 0x protocol.
+This package implements various extensions to the 0x protocol. Extension contracts can add various rules around how orders are settled while still getting the interoperability and security benefits of using the underlying 0x protocol contracts. 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-extensions --save
+```
## Bug bounty