Add README.md for each new package

This commit is contained in:
Alex Browne 2018-10-12 13:47:08 -07:00
parent d76d8abc1d
commit 8dc73d3d85
4 changed files with 209 additions and 1 deletions

View File

@ -0,0 +1,73 @@
## @0xproject/abi-gen-wrappers
Low-level 0x smart contract wrappers generated using @0xproject/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
includes some higher-level features.
## Installation
```bash
yarn add @0xproject/abi-gen-wrappers
```
**Import**
```typescript
import * as wrappers from '@0xproject/abi-gen-wrappers';
```
or
```javascript
var wrappers = require('@0xproject/abi-gen-wrappers');
```
## 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/abi-gen-wrappers yarn build
```
### Clean
```bash
yarn clean
```
### Lint
```bash
yarn lint
```
### Run Tests
```bash
yarn test
```

View File

@ -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
```

View File

@ -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"

View File

@ -0,0 +1,67 @@
## @0xproject/contract-artifacts
Smart contract compilation artifacts for the latest version of the 0x Protocol.
## Installation
```bash
yarn add @0xproject/contract-artifacts
```
**Import**
```typescript
import * as artifacts from '@0xproject/contract-artifacts';
```
or
```javascript
var artifacts = require('@0xproject/contract-artifacts');
```
## 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-artifacts yarn build
```
### Clean
```bash
yarn clean
```
### Lint
```bash
yarn lint
```
### Run Tests
```bash
yarn test
```