aboutsummaryrefslogtreecommitdiffstats
path: root/packages/website/md/docs/sol-compiler/2/usage.md
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-10-19 00:31:38 +0800
committerFabio Berger <me@fabioberger.com>2018-10-19 00:31:38 +0800
commitc4ae91c7c5aaa2d6e278448667bf828162be93bc (patch)
tree46843ed4273b158e0313897d2b5029516c4222ba /packages/website/md/docs/sol-compiler/2/usage.md
parent8b62b350b1fed6a0d8827ca9ed5fcec3e78ae82f (diff)
downloaddexon-sol-tools-c4ae91c7c5aaa2d6e278448667bf828162be93bc.tar
dexon-sol-tools-c4ae91c7c5aaa2d6e278448667bf828162be93bc.tar.gz
dexon-sol-tools-c4ae91c7c5aaa2d6e278448667bf828162be93bc.tar.bz2
dexon-sol-tools-c4ae91c7c5aaa2d6e278448667bf828162be93bc.tar.lz
dexon-sol-tools-c4ae91c7c5aaa2d6e278448667bf828162be93bc.tar.xz
dexon-sol-tools-c4ae91c7c5aaa2d6e278448667bf828162be93bc.tar.zst
dexon-sol-tools-c4ae91c7c5aaa2d6e278448667bf828162be93bc.zip
Update doc ref markdown sections
Diffstat (limited to 'packages/website/md/docs/sol-compiler/2/usage.md')
-rw-r--r--packages/website/md/docs/sol-compiler/2/usage.md24
1 files changed, 24 insertions, 0 deletions
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);
+```