From a6f72de09d7b2c9738b78d2097baa9906838fbe9 Mon Sep 17 00:00:00 2001
From: Leonid Logvinov <logvinov.leon@gmail.com>
Date: Tue, 8 May 2018 15:42:07 +0200
Subject: Rename deployer to sol-compiler

---
 packages/website/md/docs/sol-compiler/usage.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 packages/website/md/docs/sol-compiler/usage.md

(limited to 'packages/website/md/docs/sol-compiler/usage.md')

diff --git a/packages/website/md/docs/sol-compiler/usage.md b/packages/website/md/docs/sol-compiler/usage.md
new file mode 100644
index 000000000..79c9b32ba
--- /dev/null
+++ b/packages/website/md/docs/sol-compiler/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 '@0xproject/sol-compiler';
+
+const compiler = new Compiler();
+
+(async () => {
+    await compiler.compileAllAsync();
+})().catch(console.log);
+```
-- 
cgit v1.2.3