aboutsummaryrefslogtreecommitdiffstats
path: root/packages/deployer/README.md
diff options
context:
space:
mode:
authorLeonid Logvinov <logvinov.leon@gmail.com>2018-05-08 21:42:07 +0800
committerLeonid Logvinov <logvinov.leon@gmail.com>2018-05-10 23:47:38 +0800
commita6f72de09d7b2c9738b78d2097baa9906838fbe9 (patch)
tree17126a5b45dabf2c7410d25668c68ce3d78284f0 /packages/deployer/README.md
parent96037aed5231aa9344e5037aa6cff3d01f4abdae (diff)
downloaddexon-0x-contracts-a6f72de09d7b2c9738b78d2097baa9906838fbe9.tar
dexon-0x-contracts-a6f72de09d7b2c9738b78d2097baa9906838fbe9.tar.gz
dexon-0x-contracts-a6f72de09d7b2c9738b78d2097baa9906838fbe9.tar.bz2
dexon-0x-contracts-a6f72de09d7b2c9738b78d2097baa9906838fbe9.tar.lz
dexon-0x-contracts-a6f72de09d7b2c9738b78d2097baa9906838fbe9.tar.xz
dexon-0x-contracts-a6f72de09d7b2c9738b78d2097baa9906838fbe9.tar.zst
dexon-0x-contracts-a6f72de09d7b2c9738b78d2097baa9906838fbe9.zip
Rename deployer to sol-compiler
Diffstat (limited to 'packages/deployer/README.md')
-rw-r--r--packages/deployer/README.md103
1 files changed, 0 insertions, 103 deletions
diff --git a/packages/deployer/README.md b/packages/deployer/README.md
deleted file mode 100644
index 4c7de2cb0..000000000
--- a/packages/deployer/README.md
+++ /dev/null
@@ -1,103 +0,0 @@
-## @0xproject/deployer
-
-This repository contains a CLI tool that facilitates compiling and deployment of smart contracts.
-
-### Read the [Documentation](https://0xproject.com/docs/deployer).
-
-## Installation
-
-#### CLI Installation
-
-```bash
-yarn global add @0xproject/deployer
-```
-
-#### API Installation
-
-```bash
-yarn add @0xproject/deployer
-```
-
-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"],
-}
-```
-
-**Import**
-
-```typescript
-import { Compiler } from '@0xproject/deployer';
-```
-
-or
-
-```javascript
-var Compiler = require('@0xproject/deployer').Compiler;
-```
-
-## 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
-
-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
-```