aboutsummaryrefslogtreecommitdiffstats
path: root/packages/website/md/docs/sol-compiler
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-11-19 20:49:16 +0800
committerFabio Berger <me@fabioberger.com>2018-11-19 20:49:16 +0800
commit8175192f60e2c2827f6e7d664fbe8bf2d9ddee9c (patch)
tree587ce5e026674e5665ad164995aac69462290aed /packages/website/md/docs/sol-compiler
parent7d2c975d7335155b85a7549c25b953d0afacf5cf (diff)
parent94de441de744ed53470335122a38e265c3a71aff (diff)
downloaddexon-sol-tools-8175192f60e2c2827f6e7d664fbe8bf2d9ddee9c.tar
dexon-sol-tools-8175192f60e2c2827f6e7d664fbe8bf2d9ddee9c.tar.gz
dexon-sol-tools-8175192f60e2c2827f6e7d664fbe8bf2d9ddee9c.tar.bz2
dexon-sol-tools-8175192f60e2c2827f6e7d664fbe8bf2d9ddee9c.tar.lz
dexon-sol-tools-8175192f60e2c2827f6e7d664fbe8bf2d9ddee9c.tar.xz
dexon-sol-tools-8175192f60e2c2827f6e7d664fbe8bf2d9ddee9c.tar.zst
dexon-sol-tools-8175192f60e2c2827f6e7d664fbe8bf2d9ddee9c.zip
Merge branch 'development'
* development: (957 commits) fix(order_utils.py): publish docs to S3, not RTD (#1264) fix: make instant package private feat: refer to map file in postpublish configs feat: add new bundle name to bundle watch fix: tslint ignore rule in wrong place Update blog post feature Fix disclaimer on mobile Add smart contract docs to Developer Home Add Apache license link Fix capitalization in title Remove excess semi-colon Point directly to README for docs link Update icons Update LICENSE Fix disclaimer Add blogpost URL Add disclaimer Add launch kit to Developer home list of tools feat: Deploy contracts to Rinkeby fix: fix exceeds block gas limit error ...
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);
+```