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-artifacts/README.md | 67 +++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 packages/contract-artifacts/README.md (limited to 'packages/contract-artifacts') diff --git a/packages/contract-artifacts/README.md b/packages/contract-artifacts/README.md new file mode 100644 index 000000000..f8901266d --- /dev/null +++ b/packages/contract-artifacts/README.md @@ -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 +``` -- cgit v1.2.3