diff options
Diffstat (limited to 'packages/contract-addresses')
-rw-r--r-- | packages/contract-addresses/README.md | 68 | ||||
-rw-r--r-- | packages/contract-addresses/package.json | 2 |
2 files changed, 69 insertions, 1 deletions
diff --git a/packages/contract-addresses/README.md b/packages/contract-addresses/README.md new file mode 100644 index 000000000..62c062d26 --- /dev/null +++ b/packages/contract-addresses/README.md @@ -0,0 +1,68 @@ +## @0xproject/contract-addresses + +A tiny utility library for getting known deployed contract addresses for a +particular network. + +## Installation + +```bash +yarn add @0xproject/contract-addresses +``` + +**Import** + +```typescript +import { getContractAddressesForNetwork } from '@0xproject/contract-addresses'; +``` + +or + +```javascript +var getContractAddressesForNetwork = require('@0xproject/contract-addresses').getContractAddressesForNetwork; +``` + +## Contributing + +We welcome improvements and fixes from the wider community! 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 + +To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: + +```bash +PKG=@0xproject/contract-addresses yarn build +``` + +### Clean + +```bash +yarn clean +``` + +### Lint + +```bash +yarn lint +``` + +### Run Tests + +```bash +yarn test +``` diff --git a/packages/contract-addresses/package.json b/packages/contract-addresses/package.json index 47081584b..60642224f 100644 --- a/packages/contract-addresses/package.json +++ b/packages/contract-addresses/package.json @@ -4,7 +4,7 @@ "engines": { "node": ">=6.12" }, - "description": "Addresses of deployed 0x contracts on Ethereum mainnet and testnets", + "description": "Used to get known addresses of deployed 0x contracts", "main": "lib/src/index.js", "directories": { "test": "test" |