diff options
author | Leonid Logvinov <logvinov.leon@gmail.com> | 2018-02-28 09:51:31 +0800 |
---|---|---|
committer | Leonid Logvinov <logvinov.leon@gmail.com> | 2018-02-28 09:51:31 +0800 |
commit | 72e6e1ce8b66809c48e5df61108ff09dea5447ec (patch) | |
tree | 966717683a9f0442f25af01411d2ca0faea4d961 /packages/base-contract/README.md | |
parent | 7aa070f9eaef734274df6e6eaa4590fe30d52899 (diff) | |
download | dexon-0x-contracts-72e6e1ce8b66809c48e5df61108ff09dea5447ec.tar dexon-0x-contracts-72e6e1ce8b66809c48e5df61108ff09dea5447ec.tar.gz dexon-0x-contracts-72e6e1ce8b66809c48e5df61108ff09dea5447ec.tar.bz2 dexon-0x-contracts-72e6e1ce8b66809c48e5df61108ff09dea5447ec.tar.lz dexon-0x-contracts-72e6e1ce8b66809c48e5df61108ff09dea5447ec.tar.xz dexon-0x-contracts-72e6e1ce8b66809c48e5df61108ff09dea5447ec.tar.zst dexon-0x-contracts-72e6e1ce8b66809c48e5df61108ff09dea5447ec.zip |
Move BaseContract to its own package
Diffstat (limited to 'packages/base-contract/README.md')
-rw-r--r-- | packages/base-contract/README.md | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/packages/base-contract/README.md b/packages/base-contract/README.md new file mode 100644 index 000000000..ffb0d0190 --- /dev/null +++ b/packages/base-contract/README.md @@ -0,0 +1,53 @@ +## @0xproject/utils + +Utils to be shared across 0x projects and packages + +## Installation + +```bash +yarn add @0xproject/utils +``` + +## Usage + +```javascript +import { addressUtils, bigNumberConfigs, classUtils, intervalUtils, promisify } from '@0xproject/utils'; +``` + +## 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. + +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 + +```bash +yarn build +``` + +or + +```bash +yarn build:watch +``` + +### Lint + +```bash +yarn lint +``` |