aboutsummaryrefslogtreecommitdiffstats
path: root/packages/sol-coverage/README.md
diff options
context:
space:
mode:
authorLeonid Logvinov <logvinov.leon@gmail.com>2019-01-08 19:23:33 +0800
committerLeonid Logvinov <logvinov.leon@gmail.com>2019-01-08 21:48:06 +0800
commit2c974b5f3ffa0e9736000273e39cdeee4a251b94 (patch)
treea1772f93d796e3b4ba7a988194a44a3e8bcd6d31 /packages/sol-coverage/README.md
parent0ac36cef288deecd36caa601c53d13517eef5ca8 (diff)
downloaddexon-sol-tools-2c974b5f3ffa0e9736000273e39cdeee4a251b94.tar
dexon-sol-tools-2c974b5f3ffa0e9736000273e39cdeee4a251b94.tar.gz
dexon-sol-tools-2c974b5f3ffa0e9736000273e39cdeee4a251b94.tar.bz2
dexon-sol-tools-2c974b5f3ffa0e9736000273e39cdeee4a251b94.tar.lz
dexon-sol-tools-2c974b5f3ffa0e9736000273e39cdeee4a251b94.tar.xz
dexon-sol-tools-2c974b5f3ffa0e9736000273e39cdeee4a251b94.tar.zst
dexon-sol-tools-2c974b5f3ffa0e9736000273e39cdeee4a251b94.zip
Refactor out sol-cov, sol-profiler and sol-trace into their separate packages
Diffstat (limited to 'packages/sol-coverage/README.md')
-rw-r--r--packages/sol-coverage/README.md75
1 files changed, 75 insertions, 0 deletions
diff --git a/packages/sol-coverage/README.md b/packages/sol-coverage/README.md
new file mode 100644
index 000000000..f8cc62eb8
--- /dev/null
+++ b/packages/sol-coverage/README.md
@@ -0,0 +1,75 @@
+## @0x/sol-coverage
+
+A Solidity code coverage tool.
+
+### Read the [Documentation](https://0xproject.com/docs/sol-coverage).
+
+## Installation
+
+```bash
+yarn add @0x/sol-coverage
+```
+
+**Import**
+
+```javascript
+import { CoverageSubprovider } from '@0x/sol-coverage';
+```
+
+or
+
+```javascript
+var CoverageSubprovider = require('@0x/sol-coverage').CoverageSubprovider;
+```
+
+## 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=@0x/sol-coverage yarn build
+```
+
+Or continuously rebuild on change:
+
+```bash
+PKG=@0x/sol-coverage yarn watch
+```
+
+### Clean
+
+```bash
+yarn clean
+```
+
+### Lint
+
+```bash
+yarn lint
+```
+
+### Run Tests
+
+```bash
+yarn test
+```