aboutsummaryrefslogtreecommitdiffstats
path: root/packages/0x.js
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-04-06 14:05:34 +0800
committerGitHub <noreply@github.com>2018-04-06 14:05:34 +0800
commit277e58c2e57489a6ac8e8276fe16ec511d3f01fe (patch)
treeaa89d3af99680afdf4753283abf3336702dd4398 /packages/0x.js
parent21dc94b709b9a3dbe292287fb95aacddcf0175f1 (diff)
parent9745dfe2f4f15f0c23c150f3b375ff9ed2ace063 (diff)
downloaddexon-sol-tools-277e58c2e57489a6ac8e8276fe16ec511d3f01fe.tar
dexon-sol-tools-277e58c2e57489a6ac8e8276fe16ec511d3f01fe.tar.gz
dexon-sol-tools-277e58c2e57489a6ac8e8276fe16ec511d3f01fe.tar.bz2
dexon-sol-tools-277e58c2e57489a6ac8e8276fe16ec511d3f01fe.tar.lz
dexon-sol-tools-277e58c2e57489a6ac8e8276fe16ec511d3f01fe.tar.xz
dexon-sol-tools-277e58c2e57489a6ac8e8276fe16ec511d3f01fe.tar.zst
dexon-sol-tools-277e58c2e57489a6ac8e8276fe16ec511d3f01fe.zip
Merge pull request #505 from 0xProject/fix/readmeContributingSection
Improve README contributing sections in all packages
Diffstat (limited to 'packages/0x.js')
-rw-r--r--packages/0x.js/README.md70
1 files changed, 65 insertions, 5 deletions
diff --git a/packages/0x.js/README.md b/packages/0x.js/README.md
index 5b17dac8b..46848cbdd 100644
--- a/packages/0x.js/README.md
+++ b/packages/0x.js/README.md
@@ -1,5 +1,9 @@
## 0x.js
+A TypeScript/Javascript library for interacting with the 0x protocol.
+
+### Read the [Documentation](0xproject.com/docs/0xjs).
+
## Installation
0x.js ships as both a [UMD](https://github.com/umdjs/umd) module and a [CommonJS](https://en.wikipedia.org/wiki/CommonJS) package.
@@ -38,10 +42,66 @@ Download the UMD module from our [releases page](https://github.com/0xProject/0x
<script type="text/javascript" src="0x.js"></script>
```
-## Documentation
+## 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
+
+If this is your **first** time building this package, you must first build **all** packages within the monorepo. This is because packages that depend on other packages located inside this monorepo are symlinked when run from **within** the monorepo. This allows you to make changes across multiple packages without first publishing dependent packages to NPM. To build all packages, run the following from the monorepo root directory:
+
+```bash
+yarn lerna:rebuild
+```
+
+Or continuously rebuild on change:
+
+```bash
+yarn dev
+```
+
+You can also build this specific package by running the following from within its directory:
+
+```bash
+yarn build
+```
+
+or continuously rebuild on change:
+
+```bash
+yarn build:watch
+```
+
+### Clean
+
+```bash
+yarn clean
+```
+
+### Lint
-Extensive documentation of 0x.js can be found on [our website][docs-url].
+```bash
+yarn lint
+```
+
+### Run Tests
-[website-url]: https://0xproject.com/
-[whitepaper-url]: https://0xproject.com/pdfs/0x_white_paper.pdf
-[docs-url]: https://0xproject.com/docs/0xjs
+```bash
+yarn test
+```