Merge pull request #588 from 0xProject/improvement/use-wsrun

Individual package building & watching!!! 💪 🌹

2 files changed, 68 insertions, 1 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
+```
diff --git a/packages/sol-resolver/package.json b/packages/sol-resolver/package.json
index 6e4ba97e4..1240d0afb 100644
--- a/packages/sol-resolver/package.json
+++ b/packages/sol-resolver/package.json
@@ -5,7 +5,7 @@
     "main": "lib/index.js",
     "types": "lib/index.d.ts",
     "scripts": {
-        "build:watch": "tsc -w",
+        "watch": "tsc -w",
         "build": "yarn clean && tsc && copyfiles -u 3 './lib/src/monorepo_scripts/**/*' ./scripts",
         "clean": "shx rm -rf lib scripts",
         "lint": "tslint --project .",