Rename sol-trace-based-tools-common to sol-tracing-utils

1 files changed, 61 insertions, 0 deletions

diff --git a/packages/sol-tracing-utils/README.md b/packages/sol-tracing-utils/README.md
new file mode 100644
index 000000000..0a4749b8e
--- /dev/null
+++ b/packages/sol-tracing-utils/README.md
@@ -0,0 +1,61 @@
+## @0x/sol-tracing-utils
+
+Common code for all solidity trace-based tools (sol-coverage, sol-profiler, sol-trace).
+
+## Installation
+
+```bash
+yarn add @0x/sol-sol-tracing-utils
+```
+
+## 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-tracing-utils yarn build
+```
+
+Or continuously rebuild on change:
+
+```bash
+PKG=@0x/sol-tracing-utils yarn watch
+```
+
+### Clean
+
+```bash
+yarn clean
+```
+
+### Lint
+
+```bash
+yarn lint
+```
+
+### Run Tests
+
+```bash
+yarn test
+```