diff options
| author | Jacob Evans <jacob@dekz.net> | 2018-10-18 19:03:47 +0800 |
|---|---|---|
| committer | Jacob Evans <jacob@dekz.net> | 2018-10-18 19:30:09 +0800 |
| commit | 2735fb4fa6901dc528aea5f642512c161b842efd (patch) | |
| tree | e2fe194b2f8b627f89589c332c2d894027682062 | |
| parent | 88c929a408d17d8d1f4604187f8b1b04e94dab73 (diff) | |
| download | dexon-sol-tools-2735fb4fa6901dc528aea5f642512c161b842efd.tar dexon-sol-tools-2735fb4fa6901dc528aea5f642512c161b842efd.tar.gz dexon-sol-tools-2735fb4fa6901dc528aea5f642512c161b842efd.tar.bz2 dexon-sol-tools-2735fb4fa6901dc528aea5f642512c161b842efd.tar.lz dexon-sol-tools-2735fb4fa6901dc528aea5f642512c161b842efd.tar.xz dexon-sol-tools-2735fb4fa6901dc528aea5f642512c161b842efd.tar.zst dexon-sol-tools-2735fb4fa6901dc528aea5f642512c161b842efd.zip | |
chore: change README.md from 0xproject to 0x
37 files changed, 200 insertions, 200 deletions
@@ -20,38 +20,38 @@ If you're developing on 0x now or are interested in using 0x infrastructure in t ### Published Packages -| Package | Version | Description | -| --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| [`0x.js`](/packages/0x.js) | [](https://www.npmjs.com/package/0x.js) | A Javascript library for interacting with the 0x protocol | -| [`@0xproject/abi-gen`](/packages/abi-gen) | [](https://www.npmjs.com/package/@0xproject/abi-gen) | Tool to generate TS wrappers from smart contract ABIs | -| [`@0xproject/assert`](/packages/assert) | [](https://www.npmjs.com/package/@0xproject/assert) | Type and schema assertions used by our packages | -| [`@0xproject/asset-buyer`](/packages/asset-buyer) | [](https://www.npmjs.com/package/@0xproject/asset-buyer) | Convenience package for discovering and buying assets with Ether. | -| [`@0xproject/base-contract`](/packages/base-contract) | [](https://www.npmjs.com/package/@0xproject/base-contract) | BaseContract used by auto-generated `abi-gen` wrapper contracts | -| [`@0xproject/connect`](/packages/connect) | [](https://www.npmjs.com/package/@0xproject/connect) | A Javascript library for interacting with the Standard Relayer API | -| [`@0xproject/dev-utils`](/packages/dev-utils) | [](https://www.npmjs.com/package/@0xproject/dev-utils) | Dev utils to be shared across 0x projects and packages | -| [`@0xproject/json-schemas`](/packages/json-schemas) | [](https://www.npmjs.com/package/@0xproject/json-schemas) | 0x-related json schemas | -| [`@0xproject/monorepo-scripts`](/packages/monorepo-scripts) | [](https://www.npmjs.com/package/@0xproject/monorepo-scripts) | Monorepo scripts | -| [`@0xproject/order-utils`](/packages/order-utils) | [](https://www.npmjs.com/package/@0xproject/order-utils) | A set of utilities for generating, parsing, signing and validating 0x orders. | -| [`@0xproject/react-docs`](/packages/react-docs) | [](https://www.npmjs.com/package/@0xproject/react-docs) | React documentation component for rendering TypeDoc & Doxity generated JSON | -| [`@0xproject/react-shared`](/packages/react-shared) | [](https://www.npmjs.com/package/@0xproject/react-shared) | 0x shared react components | -| [`@0xproject/sol-compiler`](/packages/sol-compiler) | [](https://www.npmjs.com/package/@0xproject/sol-compiler) | A thin wrapper around Solc.js that outputs artifacts, resolves imports, only re-compiles when needed, and other niceties. | -| [`@0xproject/sol-cov`](/packages/sol-cov) | [](https://www.npmjs.com/package/@0xproject/sol-cov) | Solidity test coverage tool | -| [`@0xproject/sra-spec`](/packages/sra-spec) | [](https://www.npmjs.com/package/@0xproject/sra-spec) | OpenAPI specification for the standard relayer API | | -| [`@0xproject/subproviders`](/packages/subproviders) | [](https://www.npmjs.com/package/@0xproject/subproviders) | Useful web3 subproviders (e.g LedgerSubprovider) | -| [`@0xproject/tslint-config`](/packages/tslint-config) | [](https://www.npmjs.com/package/@0xproject/tslint-config) | Custom 0x development TSLint rules | -| [`@0xproject/types`](/packages/types) | [](https://www.npmjs.com/package/@0xproject/types) | Shared type declarations | -| [`@0xproject/typescript-typings`](/packages/typescript-typings) | [](https://www.npmjs.com/package/@0xproject/typescript-typings) | Repository of types for external packages | -| [`@0xproject/utils`](/packages/utils) | [](https://www.npmjs.com/package/@0xproject/utils) | Shared utilities | -| [`@0xproject/web3-wrapper`](/packages/web3-wrapper) | [](https://www.npmjs.com/package/@0xproject/web3-wrapper) | Web3 wrapper | +| Package | Version | Description | +| -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | +| [`0x.js`](/packages/0x.js) | [](https://www.npmjs.com/package/0x.js) | A Javascript library for interacting with the 0x protocol | +| [`@0x/abi-gen`](/packages/abi-gen) | [](https://www.npmjs.com/package/@0x/abi-gen) | Tool to generate TS wrappers from smart contract ABIs | +| [`@0x/assert`](/packages/assert) | [](https://www.npmjs.com/package/@0x/assert) | Type and schema assertions used by our packages | +| [`@0x/asset-buyer`](/packages/asset-buyer) | [](https://www.npmjs.com/package/@0x/asset-buyer) | Convenience package for discovering and buying assets with Ether. | +| [`@0x/base-contract`](/packages/base-contract) | [](https://www.npmjs.com/package/@0x/base-contract) | BaseContract used by auto-generated `abi-gen` wrapper contracts | +| [`@0x/connect`](/packages/connect) | [](https://www.npmjs.com/package/@0x/connect) | A Javascript library for interacting with the Standard Relayer API | +| [`@0x/dev-utils`](/packages/dev-utils) | [](https://www.npmjs.com/package/@0x/dev-utils) | Dev utils to be shared across 0x projects and packages | +| [`@0x/json-schemas`](/packages/json-schemas) | [](https://www.npmjs.com/package/@0x/json-schemas) | 0x-related json schemas | +| [`@0x/monorepo-scripts`](/packages/monorepo-scripts) | [](https://www.npmjs.com/package/@0x/monorepo-scripts) | Monorepo scripts | +| [`@0x/order-utils`](/packages/order-utils) | [](https://www.npmjs.com/package/@0x/order-utils) | A set of utilities for generating, parsing, signing and validating 0x orders. | +| [`@0x/react-docs`](/packages/react-docs) | [](https://www.npmjs.com/package/@0x/react-docs) | React documentation component for rendering TypeDoc & Doxity generated JSON | +| [`@0x/react-shared`](/packages/react-shared) | [](https://www.npmjs.com/package/@0x/react-shared) | 0x shared react components | +| [`@0x/sol-compiler`](/packages/sol-compiler) | [](https://www.npmjs.com/package/@0x/sol-compiler) | A thin wrapper around Solc.js that outputs artifacts, resolves imports, only re-compiles when needed, and other niceties. | +| [`@0x/sol-cov`](/packages/sol-cov) | [](https://www.npmjs.com/package/@0x/sol-cov) | Solidity test coverage tool | +| [`@0x/sra-spec`](/packages/sra-spec) | [](https://www.npmjs.com/package/@0x/sra-spec) | OpenAPI specification for the standard relayer API | +| [`@0x/subproviders`](/packages/subproviders) | [](https://www.npmjs.com/package/@0x/subproviders) | Useful web3 subproviders (e.g LedgerSubprovider) | +| [`@0x/tslint-config`](/packages/tslint-config) | [](https://www.npmjs.com/package/@0x/tslint-config) | Custom 0x development TSLint rules | +| [`@0x/types`](/packages/types) | [](https://www.npmjs.com/package/@0x/types) | Shared type declarations | +| [`@0x/typescript-typings`](/packages/typescript-typings) | [](https://www.npmjs.com/package/@0x/typescript-typings) | Repository of types for external packages | +| [`@0x/utils`](/packages/utils) | [](https://www.npmjs.com/package/@0x/utils) | Shared utilities | +| [`@0x/web3-wrapper`](/packages/web3-wrapper) | [](https://www.npmjs.com/package/@0x/web3-wrapper) | Web3 wrapper | ### Private Packages -| Package | Description | -| --------------------------------------------------------------- | ---------------------------------------------------------------- | -| [`@0xproject/contracts`](/packages/contracts) | 0x solidity smart contracts & tests | -| [`@0xproject/react-docs-example`](/packages/react-docs-example) | Example documentation site created with `@0xproject/react-docs` | -| [`@0xproject/testnet-faucets`](/packages/testnet-faucets) | A faucet micro-service that dispenses test ERC20 tokens or Ether | -| [`@0xproject/website`](/packages/website) | 0x website & Portal DApp | +| Package | Description | +| -------------------------------------------------------- | ---------------------------------------------------------------- | +| [`@0x/contracts`](/packages/contracts) | 0x solidity smart contracts & tests | +| [`@0x/react-docs-example`](/packages/react-docs-example) | Example documentation site created with `@0x/react-docs` | +| [`@0x/testnet-faucets`](/packages/testnet-faucets) | A faucet micro-service that dispenses test ERC20 tokens or Ether | +| [`@0x/website`](/packages/website) | 0x website & Portal DApp | ## Usage @@ -70,10 +70,10 @@ Dedicated documentation pages: Node version >= 6.12 is required. Most of the packages require additional typings for external dependencies. -You can include those by prepending the `@0xproject/typescript-typings` package to your [`typeRoots`](http://www.typescriptlang.org/docs/handbook/tsconfig-json.html) config. +You can include those by prepending the `@0x/typescript-typings` package to your [`typeRoots`](http://www.typescriptlang.org/docs/handbook/tsconfig-json.html) config. ```json -"typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], +"typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], ``` ## Contributing @@ -103,7 +103,7 @@ yarn build To build a specific package: ```bash -PKG=@0xproject/web3-wrapper yarn build +PKG=@0x/web3-wrapper yarn build ``` ### Watch @@ -120,7 +120,7 @@ To watch a specific package and all it's dependent packages: PKG=[NPM_PACKAGE_NAME] yarn watch e.g -PKG=@0xproject/web3-wrapper yarn watch +PKG=@0x/web3-wrapper yarn watch ``` ### Clean @@ -176,5 +176,5 @@ yarn test Run a specific package's test: ```bash -PKG=@0xproject/web3-wrapper yarn test +PKG=@0x/web3-wrapper yarn test ``` diff --git a/packages/0x.js/README.md b/packages/0x.js/README.md index 329037324..5b7a2308c 100644 --- a/packages/0x.js/README.md +++ b/packages/0x.js/README.md @@ -33,7 +33,7 @@ If your project is in [TypeScript](https://www.typescriptlang.org/), add the fol ```json "compilerOptions": { - "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], + "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], } ``` diff --git a/packages/abi-gen-wrappers/README.md b/packages/abi-gen-wrappers/README.md index f904f9af8..bcf58ae06 100644 --- a/packages/abi-gen-wrappers/README.md +++ b/packages/abi-gen-wrappers/README.md @@ -1,29 +1,29 @@ -## @0xproject/abi-gen-wrappers +## @0x/abi-gen-wrappers -Low-level 0x smart contract wrappers generated using @0xproject/abi-gen. These +Low-level 0x smart contract wrappers generated using @0x/abi-gen. These low-level wrappers are imported by other packages in the 0x monorepo and application developers are not expected to import this package directly. You may also be interested in the -[@0xproject/contract-wrappers](../contract-wrappers/README.md) package which +[@0x/contract-wrappers](../contract-wrappers/README.md) package which includes some higher-level features. ## Installation ```bash -yarn add @0xproject/abi-gen-wrappers +yarn add @0x/abi-gen-wrappers ``` **Import** ```typescript -import * as wrappers from '@0xproject/abi-gen-wrappers'; +import * as wrappers from '@0x/abi-gen-wrappers'; ``` or ```javascript -var wrappers = require('@0xproject/abi-gen-wrappers'); +var wrappers = require('@0x/abi-gen-wrappers'); ``` ## Contributing @@ -51,7 +51,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/abi-gen-wrappers yarn build +PKG=@0x/abi-gen-wrappers yarn build ``` ### Clean diff --git a/packages/abi-gen/README.md b/packages/abi-gen/README.md index b6dd37cd1..20b9d4f30 100644 --- a/packages/abi-gen/README.md +++ b/packages/abi-gen/README.md @@ -8,7 +8,7 @@ You can write your custom handlebars templates which will allow you to seamlessl ## Installation -`yarn add -g @0xproject/abi-gen` +`yarn add -g @0x/abi-gen` ## Usage @@ -82,13 +82,13 @@ 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/abi-gen yarn build +PKG=@0x/abi-gen yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/abi-gen yarn watch +PKG=@0x/abi-gen yarn watch ``` ### Clean diff --git a/packages/assert/README.md b/packages/assert/README.md index 1f2139d47..647586f15 100644 --- a/packages/assert/README.md +++ b/packages/assert/README.md @@ -1,17 +1,17 @@ -## @0xproject/assert +## @0x/assert Standard type and schema assertions to be used across all 0x projects and packages ## Installation ```bash -yarn add @0xproject/assert +yarn add @0x/assert ``` ## Usage ```typescript -import { assert } from '@0xproject/assert'; +import { assert } from '@0x/assert'; assert.isValidBaseUnitAmount('baseUnitAmount', baseUnitAmount); ``` @@ -20,7 +20,7 @@ If your project is in [TypeScript](https://www.typescriptlang.org/), add the fol ```json "compilerOptions": { - "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], + "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], } ``` @@ -49,13 +49,13 @@ 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/assert yarn build +PKG=@0x/assert yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/assert yarn watch +PKG=@0x/assert yarn watch ``` ### Clean diff --git a/packages/asset-buyer/README.md b/packages/asset-buyer/README.md index 81c7e1e85..383a3836a 100644 --- a/packages/asset-buyer/README.md +++ b/packages/asset-buyer/README.md @@ -1,4 +1,4 @@ -## @0xproject/asset-buyer +## @0x/asset-buyer **Warning: In Beta, has not been extensively tested.** @@ -9,26 +9,26 @@ In its more advanced and useful form, it integrates with the [Standard Relayer A ## Installation ```bash -yarn add @0xproject/asset-buyer +yarn add @0x/asset-buyer ``` **Import** ```typescript -import { AssetBuyer } from '@0xproject/asset-buyer'; +import { AssetBuyer } from '@0x/asset-buyer'; ``` or ```javascript -var AssetBuyer = require('@0xproject/asset-buyer').AssetBuyer; +var AssetBuyer = require('@0x/asset-buyer').AssetBuyer; ``` If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: ```json "compilerOptions": { - "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], + "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], } ``` @@ -57,13 +57,13 @@ 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/asset-buyer yarn build +PKG=@0x/asset-buyer yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/asset-buyer yarn watch +PKG=@0x/asset-buyer yarn watch ``` ### Clean diff --git a/packages/base-contract/README.md b/packages/base-contract/README.md index 4f2426c2e..b6ea05b74 100644 --- a/packages/base-contract/README.md +++ b/packages/base-contract/README.md @@ -1,25 +1,25 @@ -## @0xproject/base-contract +## @0x/base-contract BaseContract to derive all auto-generated wrappers from ## Installation ```bash -yarn add @0xproject/base-contract +yarn add @0x/base-contract ``` If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: ```json "compilerOptions": { - "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], + "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], } ``` ## Usage ```javascript -import { BaseContract } from '@0xproject/base-contract'; +import { BaseContract } from '@0x/base-contract'; ``` ## Contributing @@ -47,13 +47,13 @@ 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/base-contract yarn build +PKG=@0x/base-contract yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/base-contract yarn watch +PKG=@0x/base-contract yarn watch ``` ### Lint diff --git a/packages/connect/README.md b/packages/connect/README.md index 9d8cb9215..6d3ee66a0 100644 --- a/packages/connect/README.md +++ b/packages/connect/README.md @@ -1,18 +1,18 @@ -## @0xproject/connect +## @0x/connect This repository contains a Javascript library that makes it easy to interact with Relayers that conform to the [Standard Relayer API](https://github.com/0xProject/standard-relayer-api) ## Installation ```bash -yarn add @0xproject/connect +yarn add @0x/connect ``` If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: ```json "compilerOptions": { - "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], + "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], } ``` @@ -46,13 +46,13 @@ 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/connect yarn build +PKG=@0x/connect yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/connect yarn watch +PKG=@0x/connect yarn watch ``` ### Clean 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 diff --git a/packages/contract-artifacts/README.md b/packages/contract-artifacts/README.md index f8901266d..5a382c308 100644 --- a/packages/contract-artifacts/README.md +++ b/packages/contract-artifacts/README.md @@ -1,23 +1,23 @@ -## @0xproject/contract-artifacts +## @0x/contract-artifacts Smart contract compilation artifacts for the latest version of the 0x Protocol. ## Installation ```bash -yarn add @0xproject/contract-artifacts +yarn add @0x/contract-artifacts ``` **Import** ```typescript -import * as artifacts from '@0xproject/contract-artifacts'; +import * as artifacts from '@0x/contract-artifacts'; ``` or ```javascript -var artifacts = require('@0xproject/contract-artifacts'); +var artifacts = require('@0x/contract-artifacts'); ``` ## Contributing @@ -45,7 +45,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-artifacts yarn build +PKG=@0x/contract-artifacts yarn build ``` ### Clean diff --git a/packages/contract-wrappers/README.md b/packages/contract-wrappers/README.md index 6153f798e..36f2f48fb 100644 --- a/packages/contract-wrappers/README.md +++ b/packages/contract-wrappers/README.md @@ -1,4 +1,4 @@ -## @0xproject/contract-wrappers +## @0x/contract-wrappers Smart TS wrappers for 0x smart contracts. The wrappers have simplified interfaces, perform client-side validation on transactions and throw helpful error messages. @@ -9,20 +9,20 @@ Smart TS wrappers for 0x smart contracts. The wrappers have simplified interface **Install** ```bash -npm install @0xproject/contract-wrappers --save +npm install @0x/contract-wrappers --save ``` **Import** ```javascript -import { ContractWrappers } from '@0xproject/contract-wrappers'; +import { ContractWrappers } from '@0x/contract-wrappers'; ``` If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: ```json "compilerOptions": { - "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], + "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], } ``` @@ -51,13 +51,13 @@ 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-wrappers yarn build +PKG=@0x/contract-wrappers yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/contract-wrappers yarn watch +PKG=@0x/contract-wrappers yarn watch ``` ```bash diff --git a/packages/contract_templates/README.md b/packages/contract_templates/README.md index e5f4b09d1..c6cc3b1b3 100644 --- a/packages/contract_templates/README.md +++ b/packages/contract_templates/README.md @@ -2,7 +2,7 @@ These templates are used with [abi-gen](https://github.com/0xProject/0x-monorepo To successfully compile the generated TypeScript contract wrappers, you must: -* Install the packages on which the main contract template directly depends: `yarn add @0xproject/base-contract @0xproject/sol-compiler @0xproject/utils @0xproject/web3-wrapper ethereum-types ethers lodash` +* Install the packages on which the main contract template directly depends: `yarn add @0x/base-contract @0x/sol-compiler @0x/utils @0x/web3-wrapper ethereum-types ethers lodash` * Install the packages on which the main contract template *in*directly depends: `yarn add @types/lodash` * Ensure that your TypeScript configuration includes the following: @@ -10,7 +10,7 @@ To successfully compile the generated TypeScript contract wrappers, you must: "compilerOptions": { "lib": ["ES2015"], "typeRoots": [ - "node_modules/@0xproject/typescript-typings/types", + "node_modules/@0x/typescript-typings/types", "node_modules/@types" ] } diff --git a/packages/contracts/README.md b/packages/contracts/README.md index 33cbdae26..11579cf47 100644 --- a/packages/contracts/README.md +++ b/packages/contracts/README.md @@ -107,7 +107,7 @@ TEST_PROVIDER=geth yarn test ###### Code coverage -In order to see the Solidity code coverage output generated by `@0xproject/sol-cov`, run: +In order to see the Solidity code coverage output generated by `@0x/sol-cov`, run: ``` yarn test:coverage diff --git a/packages/dev-tools-pages/README.md b/packages/dev-tools-pages/README.md index 39fe70a25..cbc459be7 100644 --- a/packages/dev-tools-pages/README.md +++ b/packages/dev-tools-pages/README.md @@ -19,7 +19,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/dev-tools-pages yarn build +PKG=@0x/dev-tools-pages yarn build ``` Note: Ignore the `WARNING in asset size limit` and `WARNING in entrypoint size limit` warnings. diff --git a/packages/dev-utils/README.md b/packages/dev-utils/README.md index 1c3bd3a3f..73b0b8816 100644 --- a/packages/dev-utils/README.md +++ b/packages/dev-utils/README.md @@ -16,14 +16,14 @@ Boolean env variables should be either `true` or `false`. Defaults to `false` if ## Install ```bash -yarn add @0xproject/dev-utils +yarn add @0x/dev-utils ``` If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: ```json "compilerOptions": { - "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], + "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], } ``` @@ -52,13 +52,13 @@ 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/dev-utils yarn build +PKG=@0x/dev-utils yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/dev-utils yarn watch +PKG=@0x/dev-utils yarn watch ``` ### Clean diff --git a/packages/fill-scenarios/README.md b/packages/fill-scenarios/README.md index 67df0941f..794b70e56 100644 --- a/packages/fill-scenarios/README.md +++ b/packages/fill-scenarios/README.md @@ -1,18 +1,18 @@ -## @0xproject/fill-scenarios +## @0x/fill-scenarios 0x order fill scenario generator ## Installation ```bash -yarn add @0xproject/fill-scenarios +yarn add @0x/fill-scenarios ``` If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: ```json "compilerOptions": { - "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], + "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], } ``` @@ -41,13 +41,13 @@ 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/fill-scenarios yarn build +PKG=@0x/fill-scenarios yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/fill-scenarios yarn watch +PKG=@0x/fill-scenarios yarn watch ``` ### Clean diff --git a/packages/instant/README.md b/packages/instant/README.md index 25aca9d3b..55b4404e7 100644 --- a/packages/instant/README.md +++ b/packages/instant/README.md @@ -1,9 +1,9 @@ -## @0xproject/instant +## @0x/instant ## Installation ```bash -yarn add @0xproject/instant +yarn add @0x/instant ``` **Import** @@ -11,20 +11,20 @@ yarn add @0xproject/instant **CommonJS module** ```typescript -import { ZeroExInstant } from '@0xproject/instant'; +import { ZeroExInstant } from '@0x/instant'; ``` or ```javascript -var ZeroExInstant = require('@0xproject/instant').ZeroExInstant; +var ZeroExInstant = require('@0x/instant').ZeroExInstant; ``` If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: ```json "compilerOptions": { - "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], + "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], } ``` @@ -71,13 +71,13 @@ 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/instant yarn build +PKG=@0x/instant yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/instant yarn watch +PKG=@0x/instant yarn watch ``` ### Clean diff --git a/packages/json-schemas/README.md b/packages/json-schemas/README.md index ab57833be..f50382f4b 100644 --- a/packages/json-schemas/README.md +++ b/packages/json-schemas/README.md @@ -1,4 +1,4 @@ -## @0xproject/json-schemas +## @0x/json-schemas Contains 0x-related json schemas @@ -7,26 +7,26 @@ Contains 0x-related json schemas ## Installation ```bash -yarn add @0xproject/json-schemas +yarn add @0x/json-schemas ``` **Import** ```typescript -import { SchemaValidator, ValidatorResult, schemas } from '@0xproject/json-schemas'; +import { SchemaValidator, ValidatorResult, schemas } from '@0x/json-schemas'; ``` or ```javascript -var schemas = require('@0xproject/json-schemas').schemas; +var schemas = require('@0x/json-schemas').schemas; ``` If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: ```json "compilerOptions": { - "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], + "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], } ``` @@ -55,13 +55,13 @@ 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/json-schemas yarn build +PKG=@0x/json-schemas yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/json-schemas yarn watch +PKG=@0x/json-schemas yarn watch ``` ### Clean diff --git a/packages/metacoin/README.md b/packages/metacoin/README.md index 15816cc67..4f9609dde 100644 --- a/packages/metacoin/README.md +++ b/packages/metacoin/README.md @@ -1,4 +1,4 @@ -## @0xproject/metacoin +## @0x/metacoin This is an example project that demonstrates how the many Ethereum dev tools developed by 0x can be used in any Solidity/TS project. It supports: @@ -35,13 +35,13 @@ 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/metacoin yarn build +PKG=@0x/metacoin yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/metacoin yarn watch +PKG=@0x/metacoin yarn watch ``` ### Clean diff --git a/packages/migrations/README.md b/packages/migrations/README.md index f4715cfa1..926654cd8 100644 --- a/packages/migrations/README.md +++ b/packages/migrations/README.md @@ -27,13 +27,13 @@ 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/migrations yarn build +PKG=@0x/migrations yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/migrations yarn watch +PKG=@0x/migrations yarn watch ``` ### Clean diff --git a/packages/monorepo-scripts/README.md b/packages/monorepo-scripts/README.md index d979e27dc..0673098b5 100644 --- a/packages/monorepo-scripts/README.md +++ b/packages/monorepo-scripts/README.md @@ -47,13 +47,13 @@ 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/monorepo-scripts yarn build +PKG=@0x/monorepo-scripts yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/monorepo-scripts yarn watch +PKG=@0x/monorepo-scripts yarn watch ``` ### Clean diff --git a/packages/order-utils/README.md b/packages/order-utils/README.md index 33df1d4b0..4a8287098 100644 --- a/packages/order-utils/README.md +++ b/packages/order-utils/README.md @@ -1,4 +1,4 @@ -## @0xproject/order-utils +## @0x/order-utils 0x order-related utilities for those developing on top of 0x protocol. @@ -7,14 +7,14 @@ ## Installation ```bash -yarn add @0xproject/order-utils +yarn add @0x/order-utils ``` If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: ```json "compilerOptions": { - "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], + "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], } ``` @@ -43,13 +43,13 @@ 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/order-utils yarn build +PKG=@0x/order-utils yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/order-utils yarn watch +PKG=@0x/order-utils yarn watch ``` ### Clean diff --git a/packages/order-watcher/README.md b/packages/order-watcher/README.md index de64a70e7..c0b99b272 100644 --- a/packages/order-watcher/README.md +++ b/packages/order-watcher/README.md @@ -9,20 +9,20 @@ An order watcher daemon that watches for order validity. **Install** ```bash -npm install @0xproject/order-watcher --save +npm install @0x/order-watcher --save ``` **Import** ```javascript -import { OrderWatcher } from '@0xproject/order-watcher'; +import { OrderWatcher } from '@0x/order-watcher'; ``` If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: ```json "compilerOptions": { - "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], + "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], } ``` @@ -51,13 +51,13 @@ 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/order-watcher yarn build +PKG=@0x/order-watcher yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/order-watcher yarn watch +PKG=@0x/order-watcher yarn watch ``` ### Clean diff --git a/packages/react-docs/README.md b/packages/react-docs/README.md index 51e949967..19c092e4d 100644 --- a/packages/react-docs/README.md +++ b/packages/react-docs/README.md @@ -1,4 +1,4 @@ -## @0xproject/react-docs +## @0x/react-docs #### WARNING: Alpha software. Expect things to break when trying to use. @@ -24,7 +24,7 @@ A full-page React component for rendering beautiful documentation for Solidity a ## Installation ```bash -yarn add @0xproject/react-docs +yarn add @0x/react-docs ``` ## Usage @@ -37,7 +37,7 @@ If your project is in [TypeScript](https://www.typescriptlang.org/), add the fol ```json "compilerOptions": { - "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], + "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], } ``` @@ -74,13 +74,13 @@ 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/react-docs yarn build +PKG=@0x/react-docs yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/react-docs yarn watch +PKG=@0x/react-docs yarn watch ``` ### Clean diff --git a/packages/react-shared/README.md b/packages/react-shared/README.md index 88e6f18ae..7ff9a94d9 100644 --- a/packages/react-shared/README.md +++ b/packages/react-shared/README.md @@ -1,18 +1,18 @@ -## @0xproject/react-shared +## @0x/react-shared Contains React components & frontend types/utils shared between 0x projects. ## Installation ```bash -yarn add @0xproject/react-shared +yarn add @0x/react-shared ``` If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: ```json "compilerOptions": { - "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], + "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], } ``` @@ -41,13 +41,13 @@ 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/react-shared yarn build +PKG=@0x/react-shared yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/react-shared yarn watch +PKG=@0x/react-shared yarn watch ``` ### Clean diff --git a/packages/sol-compiler/README.md b/packages/sol-compiler/README.md index 3a6ca130b..445aea315 100644 --- a/packages/sol-compiler/README.md +++ b/packages/sol-compiler/README.md @@ -1,4 +1,4 @@ -## @0xproject/sol-compiler +## @0x/sol-compiler Sol-compiler is a wrapper around [solc-js](https://www.npmjs.com/package/solc) that adds: @@ -15,33 +15,33 @@ Sol-compiler is a wrapper around [solc-js](https://www.npmjs.com/package/solc) t #### CLI Installation ```bash -yarn global add @0xproject/sol-compiler +yarn global add @0x/sol-compiler ``` #### API Installation ```bash -yarn add @0xproject/sol-compiler +yarn add @0x/sol-compiler ``` If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: ```json "compilerOptions": { - "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], + "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], } ``` **Import** ```typescript -import { Compiler } from '@0xproject/sol-compiler'; +import { Compiler } from '@0x/sol-compiler'; ``` or ```javascript -var Compiler = require('@0xproject/sol-compiler').Compiler; +var Compiler = require('@0x/sol-compiler').Compiler; ``` ## Contributing @@ -69,13 +69,13 @@ 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/sol-compiler yarn build +PKG=@0x/sol-compiler yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/sol-compiler yarn watch +PKG=@0x/sol-compiler yarn watch ``` ### Clean diff --git a/packages/sol-cov/README.md b/packages/sol-cov/README.md index 0a63ac06e..31d73dc63 100644 --- a/packages/sol-cov/README.md +++ b/packages/sol-cov/README.md @@ -1,4 +1,4 @@ -## @0xproject/sol-cov +## @0x/sol-cov A Solidity code coverage tool. @@ -7,19 +7,19 @@ A Solidity code coverage tool. ## Installation ```bash -yarn add @0xproject/sol-cov +yarn add @0x/sol-cov ``` **Import** ```javascript -import { CoverageSubprovider } from '@0xproject/sol-cov'; +import { CoverageSubprovider } from '@0x/sol-cov'; ``` or ```javascript -var CoverageSubprovider = require('@0xproject/sol-cov').CoverageSubprovider; +var CoverageSubprovider = require('@0x/sol-cov').CoverageSubprovider; ``` ## Contributing @@ -47,13 +47,13 @@ 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/sol-cov yarn build +PKG=@0x/sol-cov yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/sol-cov yarn watch +PKG=@0x/sol-cov yarn watch ``` ### Clean diff --git a/packages/sol-resolver/README.md b/packages/sol-resolver/README.md index 8487947f0..2ab336bc9 100644 --- a/packages/sol-resolver/README.md +++ b/packages/sol-resolver/README.md @@ -1,23 +1,23 @@ -## @0xproject/sol-resolver +## @0x/sol-resolver A Solidity import resolver used by [sol-compiler](https://github.com/0xProject/0x-monorepo/tree/development/packages/sol-compiler). ## Installation ```bash -yarn add @0xproject/sol-resolver +yarn add @0x/sol-resolver ``` **Import** ```javascript -import { Resolver } from '@0xproject/sol-resolver'; +import { Resolver } from '@0x/sol-resolver'; ``` or ```javascript -var Resolver = require('@0xproject/sol-resolver').Resolver; +var Resolver = require('@0x/sol-resolver').Resolver; ``` ## Contributing @@ -45,13 +45,13 @@ 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/sol-resolver yarn build +PKG=@0x/sol-resolver yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/sol-resolver yarn watch +PKG=@0x/sol-resolver yarn watch ``` ### Clean diff --git a/packages/sra-spec/README.md b/packages/sra-spec/README.md index 7eee6396b..4575aaf66 100644 --- a/packages/sra-spec/README.md +++ b/packages/sra-spec/README.md @@ -1,4 +1,4 @@ -## @0xproject/sra-spec +## @0x/sra-spec Contains the Standard Relayer API [OpenAPI Spec](https://github.com/OAI/OpenAPI-Specification). @@ -9,7 +9,7 @@ A deployed [ReDoc](https://github.com/Rebilly/ReDoc) static site with the API ca ## Usage ``` -import { api } from '@0xproject/sra-spec'; +import { api } from '@0x/sra-spec'; ``` ## Installation @@ -53,13 +53,13 @@ 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/sra-spec yarn build +PKG=@0x/sra-spec yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/sra-spec yarn watch +PKG=@0x/sra-spec yarn watch ``` ### Static Site diff --git a/packages/subproviders/README.md b/packages/subproviders/README.md index 90c9b7bbe..6f97d760e 100644 --- a/packages/subproviders/README.md +++ b/packages/subproviders/README.md @@ -1,4 +1,4 @@ -## @0xproject/subproviders +## @0x/subproviders A few useful web3 subproviders including a LedgerSubprovider useful for adding Ledger Nano S support. @@ -9,14 +9,14 @@ We have written up a [Wiki](https://0xproject.com/wiki#Web3-Provider-Examples) a ## Installation ``` -yarn add @0xproject/subproviders +yarn add @0x/subproviders ``` If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: ```json "compilerOptions": { - "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], + "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], } ``` @@ -45,13 +45,13 @@ 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/subproviders yarn build +PKG=@0x/subproviders yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/subproviders yarn watch +PKG=@0x/subproviders yarn watch ``` ### Clean diff --git a/packages/testnet-faucets/README.md b/packages/testnet-faucets/README.md index a92b93fc0..8b85e3517 100644 --- a/packages/testnet-faucets/README.md +++ b/packages/testnet-faucets/README.md @@ -1,4 +1,4 @@ -## @0xproject/testnet-faucets +## @0x/testnet-faucets This faucet dispenses 0.1 test ether to one recipient per second and 0.1 test ZRX every 5 seconds. It has a max queue size of 1000. @@ -31,13 +31,13 @@ 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/testnet-faucets yarn build +PKG=@0x/testnet-faucets yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/testnet-faucets yarn watch +PKG=@0x/testnet-faucets yarn watch ``` ### Clean diff --git a/packages/tslint-config/README.md b/packages/tslint-config/README.md index d630ec84d..5614e5e54 100644 --- a/packages/tslint-config/README.md +++ b/packages/tslint-config/README.md @@ -1,11 +1,11 @@ -## @0xproject/tslint-config +## @0x/tslint-config TSLint configuration and custom linter rules used by 0xProject. ## Installation ```bash -yarn add --dev @0xproject/tslint-config +yarn add --dev @0x/tslint-config ``` ## Usage @@ -14,7 +14,7 @@ Add the following to your `tslint.json` file ```json { - "extends": ["@0xproject/tslint-config"] + "extends": ["@0x/tslint-config"] } ``` @@ -43,13 +43,13 @@ 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/tslint-config yarn build +PKG=@0x/tslint-config yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/tslint-config yarn watch +PKG=@0x/tslint-config yarn watch ``` ### Clean diff --git a/packages/types/README.md b/packages/types/README.md index c091b8302..136eb1940 100644 --- a/packages/types/README.md +++ b/packages/types/README.md @@ -1,25 +1,25 @@ -## @0xproject/types +## @0x/types Typescript types shared across 0x projects and packages ## Installation ```bash -yarn add -D @0xproject/types +yarn add -D @0x/types ``` If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: ```json "compilerOptions": { - "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], + "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], } ``` ## Usage ```javascript -import { TransactionReceipt, TxData, TxDataPayable } from '@0xproject/types'; +import { TransactionReceipt, TxData, TxDataPayable } from '@0x/types'; ``` ## Contributing @@ -47,13 +47,13 @@ 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/types yarn build +PKG=@0x/types yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/types yarn watch +PKG=@0x/types yarn watch ``` ### Clean diff --git a/packages/typescript-typings/README.md b/packages/typescript-typings/README.md index 439cb6484..e3b4c044f 100644 --- a/packages/typescript-typings/README.md +++ b/packages/typescript-typings/README.md @@ -1,11 +1,11 @@ -## @0xproject/typescript-typings +## @0x/typescript-typings Type repository for external packages used by 0x. This is like our small version of [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped) ## Installation ```bash -yarn add -D @0xproject/typescript-typings +yarn add -D @0x/typescript-typings ``` ## Usage @@ -13,7 +13,7 @@ yarn add -D @0xproject/typescript-typings Add the following line within an `compilerOptions` section of your `tsconfig.json` ```json -"typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"] +"typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"] ``` This will allow the TS compiler to first look into that repo and then fallback to DT types. @@ -43,13 +43,13 @@ 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/typescript-typings yarn build +PKG=@0x/typescript-typings yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/typescript-typings yarn watch +PKG=@0x/typescript-typings yarn watch ``` ### Clean diff --git a/packages/utils/README.md b/packages/utils/README.md index c9a2f5846..0b15f00c5 100644 --- a/packages/utils/README.md +++ b/packages/utils/README.md @@ -1,25 +1,25 @@ -## @0xproject/utils +## @0x/utils Utils to be shared across 0x projects and packages ## Installation ```bash -yarn add @0xproject/utils +yarn add @0x/utils ``` If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: ```json "compilerOptions": { - "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], + "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], } ``` ## Usage ```javascript -import { addressUtils, bigNumberConfigs, classUtils, intervalUtils, promisify } from '@0xproject/utils'; +import { addressUtils, bigNumberConfigs, classUtils, intervalUtils, promisify } from '@0x/utils'; ``` ## Troubleshooting @@ -62,13 +62,13 @@ 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/utils yarn build +PKG=@0x/utils yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/utils yarn watch +PKG=@0x/utils yarn watch ``` ### Clean diff --git a/packages/web3-wrapper/README.md b/packages/web3-wrapper/README.md index 06c788101..4402de19c 100644 --- a/packages/web3-wrapper/README.md +++ b/packages/web3-wrapper/README.md @@ -1,4 +1,4 @@ -## @0xproject/web3-wrapper +## @0x/web3-wrapper Web3-wrapper is a JSON-RPC client for Ethereum nodes. It is a type-safe alternative to [Web3.js](https://github.com/ethereum/web3.js/) written in TypeScript. @@ -7,14 +7,14 @@ Web3-wrapper is a JSON-RPC client for Ethereum nodes. It is a type-safe alternat ## Installation ```bash -yarn add @0xproject/web3-wrapper +yarn add @0x/web3-wrapper ``` If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: ```json "compilerOptions": { - "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], + "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"], } ``` @@ -43,13 +43,13 @@ 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/web3-wrapper yarn build +PKG=@0x/web3-wrapper yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/web3-wrapper yarn watch +PKG=@0x/web3-wrapper yarn watch ``` ### Clean diff --git a/packages/website/README.md b/packages/website/README.md index 2edc17cd9..d82d045a6 100644 --- a/packages/website/README.md +++ b/packages/website/README.md @@ -33,13 +33,13 @@ 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/website yarn build +PKG=@0x/website yarn build ``` ### Run dev server ```bash -PKG=@0xproject/website yarn watch +PKG=@0x/website yarn watch ``` Visit [0xproject.localhost:3572](http://0xproject.localhost:3572) in your browser. |