From 8dc73d3d853e3ec8b76ee73dbd21dd758728a9bc Mon Sep 17 00:00:00 2001 From: Alex Browne Date: Fri, 12 Oct 2018 13:47:08 -0700 Subject: Add README.md for each new package --- packages/contract-addresses/README.md | 68 +++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 packages/contract-addresses/README.md (limited to 'packages/contract-addresses/README.md') 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 +``` -- cgit v1.2.3 From 38b146c395429f860f57fa1865e01175eee39e62 Mon Sep 17 00:00:00 2001 From: Alex Browne Date: Mon, 15 Oct 2018 14:22:48 -0700 Subject: Add OrThrow suffix to getContractAddressesForNetwork --- packages/contract-addresses/README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'packages/contract-addresses/README.md') diff --git a/packages/contract-addresses/README.md b/packages/contract-addresses/README.md index 62c062d26..6c615c422 100644 --- a/packages/contract-addresses/README.md +++ b/packages/contract-addresses/README.md @@ -12,13 +12,14 @@ yarn add @0xproject/contract-addresses **Import** ```typescript -import { getContractAddressesForNetwork } from '@0xproject/contract-addresses'; +import { getContractAddressesForNetworkOrThrow } from '@0xproject/contract-addresses'; ``` or ```javascript -var getContractAddressesForNetwork = require('@0xproject/contract-addresses').getContractAddressesForNetwork; +var getContractAddressesForNetworkOrThrow = require('@0xproject/contract-addresses') + .getContractAddressesForNetworkOrThrow; ``` ## Contributing -- cgit v1.2.3 From 2735fb4fa6901dc528aea5f642512c161b842efd Mon Sep 17 00:00:00 2001 From: Jacob Evans Date: Thu, 18 Oct 2018 22:03:47 +1100 Subject: chore: change README.md from 0xproject to 0x --- packages/contract-addresses/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'packages/contract-addresses/README.md') diff --git a/packages/contract-addresses/README.md b/packages/contract-addresses/README.md index 6c615c422..3631bb968 100644 --- a/packages/contract-addresses/README.md +++ b/packages/contract-addresses/README.md @@ -1,4 +1,4 @@ -## @0xproject/contract-addresses +## @0x/contract-addresses A tiny utility library for getting known deployed contract addresses for a particular network. @@ -6,19 +6,19 @@ particular network. ## Installation ```bash -yarn add @0xproject/contract-addresses +yarn add @0x/contract-addresses ``` **Import** ```typescript -import { getContractAddressesForNetworkOrThrow } from '@0xproject/contract-addresses'; +import { getContractAddressesForNetworkOrThrow } from '@0x/contract-addresses'; ``` or ```javascript -var getContractAddressesForNetworkOrThrow = require('@0xproject/contract-addresses') +var getContractAddressesForNetworkOrThrow = require('@0x/contract-addresses') .getContractAddressesForNetworkOrThrow; ``` @@ -47,7 +47,7 @@ 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=@0xproject/contract-addresses yarn build +PKG=@0x/contract-addresses yarn build ``` ### Clean -- cgit v1.2.3 From ece76e58748f235c73a662b748ccb695ac20c1e0 Mon Sep 17 00:00:00 2001 From: Leonid Logvinov Date: Thu, 18 Oct 2018 15:27:07 +0200 Subject: Fix prettier issues --- packages/contract-addresses/README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'packages/contract-addresses/README.md') diff --git a/packages/contract-addresses/README.md b/packages/contract-addresses/README.md index 3631bb968..a4040cb54 100644 --- a/packages/contract-addresses/README.md +++ b/packages/contract-addresses/README.md @@ -18,8 +18,7 @@ import { getContractAddressesForNetworkOrThrow } from '@0x/contract-addresses'; or ```javascript -var getContractAddressesForNetworkOrThrow = require('@0x/contract-addresses') - .getContractAddressesForNetworkOrThrow; +var getContractAddressesForNetworkOrThrow = require('@0x/contract-addresses').getContractAddressesForNetworkOrThrow; ``` ## Contributing -- cgit v1.2.3