aboutsummaryrefslogtreecommitdiffstats
path: root/packages/0x.js/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'packages/0x.js/README.md')
-rw-r--r--packages/0x.js/README.md102
1 files changed, 0 insertions, 102 deletions
diff --git a/packages/0x.js/README.md b/packages/0x.js/README.md
deleted file mode 100644
index 5b7a2308c..000000000
--- a/packages/0x.js/README.md
+++ /dev/null
@@ -1,102 +0,0 @@
-## 0x.js
-
-A TypeScript/Javascript library for interacting with the 0x protocol. It is a high level package which combines a number of underlying packages such as order-utils and order-watcher.
-
-### Read the [Documentation](https://0xproject.com/docs/0x.js).
-
-## Installation
-
-0x.js ships as both a [UMD](https://github.com/umdjs/umd) module and a [CommonJS](https://en.wikipedia.org/wiki/CommonJS) package.
-
-#### CommonJS _(recommended)_:
-
-**Install**
-
-```bash
-npm install 0x.js --save
-```
-
-**Import**
-
-```javascript
-import {
- assetDataUtils,
- BigNumber,
- ContractWrappers,
- generatePseudoRandomSalt,
- orderHashUtils,
- signatureUtils,
-} from '0x.js';
-```
-
-If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:
-
-```json
-"compilerOptions": {
- "typeRoots": ["node_modules/@0x/typescript-typings/types", "node_modules/@types"],
-}
-```
-
-#### UMD:
-
-**Install**
-
-Download the UMD module from our [releases page](https://github.com/0xProject/0x-monorepo/releases) and add it to your project.
-
-**Import**
-
-```html
-<script type="text/javascript" src="0x.js"></script>
-```
-
-## Contributing
-
-We strongly recommend that the community help us make improvements and determine the future direction of 0x 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
-
-To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:
-
-```bash
-PKG=0x.js yarn build
-```
-
-Or continuously rebuild on change:
-
-```bash
-PKG=0x.js yarn watch
-```
-
-### Clean
-
-```bash
-yarn clean
-```
-
-### Lint
-
-```bash
-yarn lint
-```
-
-### Run Tests
-
-```bash
-yarn test
-```