diff options
author | Fabio Berger <me@fabioberger.com> | 2018-05-15 01:23:50 +0800 |
---|---|---|
committer | Fabio Berger <me@fabioberger.com> | 2018-05-15 01:23:50 +0800 |
commit | 478f6ed011185b66ac87323c6d9ad1f598060760 (patch) | |
tree | 09c4619287e0fc874c0258f722f543b7c6ce7f5e /packages/sol-resolver/README.md | |
parent | c94d1b22754c1d1bf10f0dd2b9c13eea91e17cb6 (diff) | |
download | dexon-sol-tools-478f6ed011185b66ac87323c6d9ad1f598060760.tar dexon-sol-tools-478f6ed011185b66ac87323c6d9ad1f598060760.tar.gz dexon-sol-tools-478f6ed011185b66ac87323c6d9ad1f598060760.tar.bz2 dexon-sol-tools-478f6ed011185b66ac87323c6d9ad1f598060760.tar.lz dexon-sol-tools-478f6ed011185b66ac87323c6d9ad1f598060760.tar.xz dexon-sol-tools-478f6ed011185b66ac87323c6d9ad1f598060760.tar.zst dexon-sol-tools-478f6ed011185b66ac87323c6d9ad1f598060760.zip |
Move from using lerna multi-package commands to wsrun, update README's accordingly
Diffstat (limited to 'packages/sol-resolver/README.md')
-rw-r--r-- | packages/sol-resolver/README.md | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/packages/sol-resolver/README.md b/packages/sol-resolver/README.md new file mode 100644 index 000000000..8487947f0 --- /dev/null +++ b/packages/sol-resolver/README.md @@ -0,0 +1,67 @@ +## @0xproject/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 +``` + +**Import** + +```javascript +import { Resolver } from '@0xproject/sol-resolver'; +``` + +or + +```javascript +var Resolver = require('@0xproject/sol-resolver').Resolver; +``` + +## 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/sol-resolver yarn build +``` + +Or continuously rebuild on change: + +```bash +PKG=@0xproject/sol-resolver yarn watch +``` + +### Clean + +```bash +yarn clean +``` + +### Lint + +```bash +yarn lint +``` |