Merge pull request #574 from 0xProject/feature/rm-rf-deployer

Remove @0xproject/deployer.Deployer. Make contracts able to deploy themselves

1 files changed, 24 insertions, 0 deletions

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);
+```