aboutsummaryrefslogtreecommitdiffstats
path: root/contracts/multisig/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/multisig/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/multisig/README.md')
-rw-r--r--contracts/multisig/README.md15
1 files changed, 7 insertions, 8 deletions
diff --git a/contracts/multisig/README.md b/contracts/multisig/README.md
index e29f46251..98cd8a080 100644
--- a/contracts/multisig/README.md
+++ b/contracts/multisig/README.md
@@ -1,15 +1,14 @@
-## MultisSig Contracts
+## MultiSignature Contracts
-MultiSig smart contracts
+This package contains various types of multisignature wallet contracts, including the [`AssetProxyOwner`](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md#assetproxyowner) contract that is responsible for upgrading the 0x protocol smart 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
-Contracts can be found in the [contracts](./contracts) directory. The contents of this directory are broken down into the following subdirectories:
+**Install**
-- [multisig](./contracts/multisig)
- - This directory contains the [Gnosis MultiSigWallet](https://github.com/gnosis/MultiSigWallet) and a custom extension that adds a timelock to transactions within the MultiSigWallet.
-- [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-multisig --save
+```
## Contributing