diff options
Diffstat (limited to 'packages/website')
| -rw-r--r-- | packages/website/md/docs/deployer/installation.md | 10 | ||||
| -rw-r--r-- | packages/website/md/docs/deployer/introduction.md | 2 | ||||
| -rw-r--r-- | packages/website/md/docs/deployer/usage.md | 29 |
3 files changed, 26 insertions, 15 deletions
diff --git a/packages/website/md/docs/deployer/installation.md b/packages/website/md/docs/deployer/installation.md index 9f3838054..48dd52c1f 100644 --- a/packages/website/md/docs/deployer/installation.md +++ b/packages/website/md/docs/deployer/installation.md @@ -1,4 +1,10 @@ -**Install** +#### CLI Installation + +```bash +npm install @0xproject/deployer -g +``` + +#### API Installation ```bash npm install @0xproject/deployer --save @@ -6,7 +12,7 @@ npm install @0xproject/deployer --save **Import** -```javascript +```typescript import { Deployer, Compiler } from '@0xproject/deployer'; ``` diff --git a/packages/website/md/docs/deployer/introduction.md b/packages/website/md/docs/deployer/introduction.md index ba9d3735a..114b71bde 100644 --- a/packages/website/md/docs/deployer/introduction.md +++ b/packages/website/md/docs/deployer/introduction.md @@ -1,6 +1,6 @@ Welcome to the [Deployer](https://github.com/0xProject/0x-monorepo/tree/development/packages/deployer) documentation! Deployer is a tool for compiling and deploying Solidity smart contracts with ease. -It serves a similar purpose to the [Truffle framework](http://truffleframework.com/), but for intermediate to advanced Solidity developers that require greater configurability and reliability. +It serves a similar purpose as parts of the [Truffle framework](http://truffleframework.com/), but with the UNIX philosophy in mind: Make each program do one thing well. This tool is for intermediate to advanced Solidity developers that require greater configurability and reliability. Deployer has the following advantages over Truffle: diff --git a/packages/website/md/docs/deployer/usage.md b/packages/website/md/docs/deployer/usage.md index 027389eac..2cfd5ca37 100644 --- a/packages/website/md/docs/deployer/usage.md +++ b/packages/website/md/docs/deployer/usage.md @@ -1,33 +1,36 @@ -### CLI Usage +#### CLI Usage ```bash -node ./node_modules/@0xproject/deployer/lib/cli.js --help -cli.js [command] +$ 0x-deployer --help +0x-deployer [command] Commands: - cli.js compile compile contracts - cli.js deploy deploy a single contract with provided arguments + 0x-deployer compile compile contracts + 0x-deployer migrate compile and deploy contracts using migration scripts + 0x-deployer deploy deploy a single contract with provided arguments Options: --version Show version number [boolean] - --contracts-dir path of contracts directory to compile - [string] [default: "/Users/leonidlogvinov/Dev/0x/contracts"] + --contracts-dir path of contracts directory to compile [string] [default: + "/path/to/contracts"] --network-id mainnet=1, kovan=42, testrpc=50 [number] [default: 50] --should-optimize enable optimizer [boolean] [default: false] - --artifacts-dir path to write contracts artifacts to - [string] [default: "/Users/leonidlogvinov/Dev/0x/build/artifacts/"] + --artifacts-dir path to write contracts artifacts to [string] [default: + "/path/to/artifacts"] --jsonrpc-port port connected to JSON RPC [number] [default: 8545] --gas-price gasPrice to be used for transactions [string] [default: "2000000000"] --account account to use for deploying contracts [string] + --contracts comma separated list of contracts to compile + [string] [default: "*"] --help Show help [boolean] ``` -### API Usage +#### API Usage -#### Migrations +##### Migrations -You might want to write a migration scripts (similar to `truffle migrate`), that deploys multiple contracts and configures them. Below you'll find a simple example of such a script to help you get started. +You can write migration scripts (similar to `truffle migrate`), that deploys multiple contracts and configures them. Below you'll find a simple example of such a script to help you get started. ```typescript import { Deployer } from '@0xproject/deployer'; @@ -49,4 +52,6 @@ const deployer = new Deployer(deployerOpts); })().catch(console.log); ``` +**Tip:** Be sure to start an Ethereum node at the supplied `jsonrpcUrl`. We recommend testing with [Ganache-cli](https://github.com/trufflesuite/ganache-cli) + A more sophisticated example can be found [here](https://github.com/0xProject/0x-monorepo/tree/development/packages/contracts/migrations) |