diff options
| author | Fabio Berger <me@fabioberger.com> | 2018-03-11 20:24:34 +0800 |
|---|---|---|
| committer | Fabio Berger <me@fabioberger.com> | 2018-03-11 20:24:34 +0800 |
| commit | a6571b09d2087ffb9a4860c0db3d7344321fe2c3 (patch) | |
| tree | 82c3cdc7c1716d0766c5eba3e086f1c904785a80 /README.md | |
| parent | 870ba445b85aec8331059ebdc80e8d37d73bf9cf (diff) | |
| download | dexon-sol-tools-a6571b09d2087ffb9a4860c0db3d7344321fe2c3.tar dexon-sol-tools-a6571b09d2087ffb9a4860c0db3d7344321fe2c3.tar.gz dexon-sol-tools-a6571b09d2087ffb9a4860c0db3d7344321fe2c3.tar.bz2 dexon-sol-tools-a6571b09d2087ffb9a4860c0db3d7344321fe2c3.tar.lz dexon-sol-tools-a6571b09d2087ffb9a4860c0db3d7344321fe2c3.tar.xz dexon-sol-tools-a6571b09d2087ffb9a4860c0db3d7344321fe2c3.tar.zst dexon-sol-tools-a6571b09d2087ffb9a4860c0db3d7344321fe2c3.zip | |
Improve README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 19 |
1 files changed, 10 insertions, 9 deletions
@@ -23,11 +23,11 @@ This repository is a monorepo including the 0x protocol smart contracts and nume | [`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/base-contract`](/packages/base-contract) | [](https://www.npmjs.com/package/@0xproject/base-contract) | BaseContract to derive all auto-generated wrappers from | +| [`@0xproject/base-contract`](/packages/base-contract) | [](https://www.npmjs.com/package/@0xproject/base-contract) | BaseContract used by auto-generated `abi-gen` wrapper contracts | | [`chai-as-promised-typescript-typings`](/packages/chai-as-promised-typescript-typings) | [](https://www.npmjs.com/package/chai-as-promised-typescript-typings) | Chai as promised typescript typings | | [`chai-typescript-typings`](/packages/chai-typescript-typings) | [](https://www.npmjs.com/package/chai-typescript-typings) | Chai typescript typings | -| [`@0xproject/connect`](/packages/connect) | [](https://www.npmjs.com/package/@0xproject/connect) | A Javascript library for interacting with the standard relayer api | -| [`@0xproject/deployer`](/packages/deployer) | [](https://www.npmjs.com/package/@0xproject/deployer) | Smart contract deployer | +| [`@0xproject/connect`](/packages/connect) | [](https://www.npmjs.com/package/@0xproject/connect) | A Javascript library for interacting with the Standard Relayer API | +| [`@0xproject/deployer`](/packages/deployer) | [](https://www.npmjs.com/package/@0xproject/deployer) | Solidity project compiler and deployer framework | | [`@0xproject/dev-utils`](/packages/dev-utils) | [](https://www.npmjs.com/package/@0xproject/dev-utils) | Dev utils to be shared across 0x projects and packages | | [`ethers-typescript-typings`](/packages/ethers-typescript-typings) | [](https://www.npmjs.com/package/ethers-typescript-typings) | [Ethers.js](https://github.com/ethers-io/ethers.js/) typescript typings | | [`@0xproject/json-schemas`](/packages/json-schemas) | [](https://www.npmjs.com/package/@0xproject/json-schemas) | 0x-related json schemas | @@ -43,12 +43,13 @@ This repository is a monorepo including the 0x protocol smart contracts and nume ### Private Packages -| Package | Description | -| ----------------------------------------------------------- | ---------------------------------------------------------------- | -| [`@0xproject/contracts`](/packages/contracts) | 0x solidity smart contracts & tests | -| [`@0xproject/monorepo-scripts`](/packages/monorepo-scripts) | Shared monorepo scripts | -| [`@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 | +| --------------------------------------------------------------- | ---------------------------------------------------------------- | +| [`@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/monorepo-scripts`](/packages/monorepo-scripts) | Shared monorepo scripts | +| [`@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 | ## Usage |