aboutsummaryrefslogtreecommitdiffstats
path: root/packages/website/md/docs/sol-compiler
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
parent8b62b350b1fed6a0d8827ca9ed5fcec3e78ae82f (diff)
downloaddexon-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')
-rw-r--r--packages/website/md/docs/sol-compiler/1/installation.md (renamed from packages/website/md/docs/sol-compiler/installation.md)0
-rw-r--r--packages/website/md/docs/sol-compiler/1/introduction.md (renamed from packages/website/md/docs/sol-compiler/introduction.md)0
-rw-r--r--packages/website/md/docs/sol-compiler/1/usage.md (renamed from packages/website/md/docs/sol-compiler/usage.md)0
-rw-r--r--packages/website/md/docs/sol-compiler/2/installation.md23
-rw-r--r--packages/website/md/docs/sol-compiler/2/usage.md24
5 files changed, 47 insertions, 0 deletions
diff --git a/packages/website/md/docs/sol-compiler/installation.md b/packages/website/md/docs/sol-compiler/1/installation.md
index 9c8561d9b..9c8561d9b 100644
--- a/packages/website/md/docs/sol-compiler/installation.md
+++ b/packages/website/md/docs/sol-compiler/1/installation.md
diff --git a/packages/website/md/docs/sol-compiler/introduction.md b/packages/website/md/docs/sol-compiler/1/introduction.md
index fcd80f47b..fcd80f47b 100644
--- a/packages/website/md/docs/sol-compiler/introduction.md
+++ b/packages/website/md/docs/sol-compiler/1/introduction.md
diff --git a/packages/website/md/docs/sol-compiler/usage.md b/packages/website/md/docs/sol-compiler/1/usage.md
index 79c9b32ba..79c9b32ba 100644
--- a/packages/website/md/docs/sol-compiler/usage.md
+++ b/packages/website/md/docs/sol-compiler/1/usage.md
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);
+```