diff options
author | Fabio Berger <me@fabioberger.com> | 2018-10-19 00:31:38 +0800 |
---|---|---|
committer | Fabio Berger <me@fabioberger.com> | 2018-10-19 00:31:38 +0800 |
commit | c4ae91c7c5aaa2d6e278448667bf828162be93bc (patch) | |
tree | 46843ed4273b158e0313897d2b5029516c4222ba /packages/website/md/docs/sol-compiler/2 | |
parent | 8b62b350b1fed6a0d8827ca9ed5fcec3e78ae82f (diff) | |
download | dexon-0x-contracts-c4ae91c7c5aaa2d6e278448667bf828162be93bc.tar.gz dexon-0x-contracts-c4ae91c7c5aaa2d6e278448667bf828162be93bc.tar.zst dexon-0x-contracts-c4ae91c7c5aaa2d6e278448667bf828162be93bc.zip |
Update doc ref markdown sections
Diffstat (limited to 'packages/website/md/docs/sol-compiler/2')
-rw-r--r-- | packages/website/md/docs/sol-compiler/2/installation.md | 23 | ||||
-rw-r--r-- | packages/website/md/docs/sol-compiler/2/usage.md | 24 |
2 files changed, 47 insertions, 0 deletions
diff --git a/packages/website/md/docs/sol-compiler/2/installation.md b/packages/website/md/docs/sol-compiler/2/installation.md new file mode 100644 index 000000000..7e7b690fe --- /dev/null +++ b/packages/website/md/docs/sol-compiler/2/installation.md @@ -0,0 +1,23 @@ +#### CLI Installation + +```bash +yarn global add @0x/sol-compiler +``` + +#### API Installation + +```bash +yarn add @0x/sol-compiler +``` + +**Import** + +```typescript +import { Compiler } from '@0x/sol-compiler'; +``` + +or + +```javascript +var Compiler = require('@0x/sol-compiler').Compiler; +``` diff --git a/packages/website/md/docs/sol-compiler/2/usage.md b/packages/website/md/docs/sol-compiler/2/usage.md new file mode 100644 index 000000000..68e5a988f --- /dev/null +++ b/packages/website/md/docs/sol-compiler/2/usage.md @@ -0,0 +1,24 @@ +#### CLI Usage + +```bash +$ sol-compiler +Options: + --version Show version number [boolean] + --contracts-dir path of contracts directory to compile [string] + --artifacts-dir path to write contracts artifacts to [string] + --contracts comma separated list of contracts to compile + [string] [default: "*"] + --help Show help [boolean] +``` + +#### API Usage + +```typescript +import { Compiler } from '@0x/sol-compiler'; + +const compiler = new Compiler(); + +(async () => { + await compiler.compileAllAsync(); +})().catch(console.log); +``` |