diff options
Diffstat (limited to 'packages/order-watcher/README.md')
-rw-r--r-- | packages/order-watcher/README.md | 91 |
1 files changed, 91 insertions, 0 deletions
diff --git a/packages/order-watcher/README.md b/packages/order-watcher/README.md new file mode 100644 index 000000000..d461dca8d --- /dev/null +++ b/packages/order-watcher/README.md @@ -0,0 +1,91 @@ +## OrderWatcher + +An order watcher daemon that watches for order validity. + +#### Read the wiki [article](https://0xproject.com/wiki#0x-OrderWatcher). + +## Installation + +**Install** + +```bash +npm install @0xproject/order-watcher --save +``` + +**Import** + +```javascript +import { OrderWatcher } from '@0xproject/order-watcher'; +``` + +If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`: + +```json +"compilerOptions": { + "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"], +} +``` + +## 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 + +```bash +yarn lint +``` + +### Run Tests + +```bash +yarn test +``` |