aboutsummaryrefslogtreecommitdiffstats
path: root/packages/monorepo-scripts
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2017-12-20 22:14:04 +0800
committerGitHub <noreply@github.com>2017-12-20 22:14:04 +0800
commit439fe10e1e42821aea3cacc12faa20509c688c32 (patch)
tree56356cb71cd56853c7526e8beec276468823ed48 /packages/monorepo-scripts
parentb603197ae837dca86d712760f9b18f626628096a (diff)
parent1d430cf62fa6e957c15fbdf77524c6527d8df319 (diff)
downloaddexon-sol-tools-439fe10e1e42821aea3cacc12faa20509c688c32.tar
dexon-sol-tools-439fe10e1e42821aea3cacc12faa20509c688c32.tar.gz
dexon-sol-tools-439fe10e1e42821aea3cacc12faa20509c688c32.tar.bz2
dexon-sol-tools-439fe10e1e42821aea3cacc12faa20509c688c32.tar.lz
dexon-sol-tools-439fe10e1e42821aea3cacc12faa20509c688c32.tar.xz
dexon-sol-tools-439fe10e1e42821aea3cacc12faa20509c688c32.tar.zst
dexon-sol-tools-439fe10e1e42821aea3cacc12faa20509c688c32.zip
Merge pull request #284 from 0xProject/feature/newAndImprovedReadmes
Improve/Add to README's
Diffstat (limited to 'packages/monorepo-scripts')
-rw-r--r--packages/monorepo-scripts/README.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/packages/monorepo-scripts/README.md b/packages/monorepo-scripts/README.md
new file mode 100644
index 000000000..452e0f94c
--- /dev/null
+++ b/packages/monorepo-scripts/README.md
@@ -0,0 +1,51 @@
+Mono repo scripts
+------
+
+This repository contains a few helpful scripts for working with this mono repo.
+
+## Usage
+
+#### Dependency versions
+In order to reduce the size of this repo, we try and use the same versions of dependencies between packages. To make it easier to discover version discrepancies between packages, you can run:
+
+```bash
+yarn deps_versions
+```
+
+This will list out any dependencies that differ in versions between packages.
+
+## Contributing
+
+We strongly recommend that the community help us make improvements and determine the future direction of the protocol. 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
+
+```bash
+yarn build
+```
+
+### Clean
+
+```bash
+yarn clean
+```
+
+### Lint
+
+```bash
+yarn lint
+```