aboutsummaryrefslogtreecommitdiffstats
path: root/packages/website/md/docs/deployer/introduction.md
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-03-16 02:23:21 +0800
committerFabio Berger <me@fabioberger.com>2018-03-16 02:23:21 +0800
commitf9ad97b978ae4017adca032168ae7963c94e4157 (patch)
treecaa1165c04c66c010062ec99160ae6ba4b147917 /packages/website/md/docs/deployer/introduction.md
parentb145a17d11a8f5ac70170b605030c42e60a4260c (diff)
downloaddexon-sol-tools-f9ad97b978ae4017adca032168ae7963c94e4157.tar.gz
dexon-sol-tools-f9ad97b978ae4017adca032168ae7963c94e4157.tar.zst
dexon-sol-tools-f9ad97b978ae4017adca032168ae7963c94e4157.zip
Add Deployer docs to website
Diffstat (limited to 'packages/website/md/docs/deployer/introduction.md')
-rw-r--r--packages/website/md/docs/deployer/introduction.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/packages/website/md/docs/deployer/introduction.md b/packages/website/md/docs/deployer/introduction.md
new file mode 100644
index 000000000..ba9d3735a
--- /dev/null
+++ b/packages/website/md/docs/deployer/introduction.md
@@ -0,0 +1,17 @@
+Welcome to the [Deployer](https://github.com/0xProject/0x-monorepo/tree/development/packages/deployer) documentation! Deployer is a tool for compiling and deploying Solidity smart contracts with ease.
+
+It serves a similar purpose to the [Truffle framework](http://truffleframework.com/), but for intermediate to advanced Solidity developers that require greater configurability and reliability.
+
+Deployer has the following advantages over Truffle:
+
+* Deploy each smart contract with a specific version of Solidity
+* Improved artifact files:
+ * Properly segregated artifacts to support storing different versions of smart contract deployed on different networks.
+ * Storage of contructor args and contract source code
+* An easy to maintain codebase: TypeScript + Single package
+* Allows you to specify the deployer address
+* Migrations that work with `async/await`
+* Migrations that can be written synchronously in order to guarentee deterministic contract addresses
+* No race conditions when running migrations.
+
+Deployer can be used as a command-line tool or as an imported module.