aboutsummaryrefslogtreecommitdiffstats
path: root/packages/website/md/docs
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-11-21 19:47:24 +0800
committerFabio Berger <me@fabioberger.com>2018-11-21 19:47:24 +0800
commitdb26ca977f56468e1ce7dbb30ed38e537912e545 (patch)
tree887a8fbdad96d66994f18f3d2a8ed9d4fe9867ae /packages/website/md/docs
parenta8803431b3e339552c989d7567bf6241f39a2bdf (diff)
downloaddexon-sol-tools-db26ca977f56468e1ce7dbb30ed38e537912e545.tar
dexon-sol-tools-db26ca977f56468e1ce7dbb30ed38e537912e545.tar.gz
dexon-sol-tools-db26ca977f56468e1ce7dbb30ed38e537912e545.tar.bz2
dexon-sol-tools-db26ca977f56468e1ce7dbb30ed38e537912e545.tar.lz
dexon-sol-tools-db26ca977f56468e1ce7dbb30ed38e537912e545.tar.xz
dexon-sol-tools-db26ca977f56468e1ce7dbb30ed38e537912e545.tar.zst
dexon-sol-tools-db26ca977f56468e1ce7dbb30ed38e537912e545.zip
Create migrations doc reference page
Diffstat (limited to 'packages/website/md/docs')
-rw-r--r--packages/website/md/docs/migrations/1/installation.md17
-rw-r--r--packages/website/md/docs/migrations/1/introduction.md1
2 files changed, 18 insertions, 0 deletions
diff --git a/packages/website/md/docs/migrations/1/installation.md b/packages/website/md/docs/migrations/1/installation.md
new file mode 100644
index 000000000..78403037b
--- /dev/null
+++ b/packages/website/md/docs/migrations/1/installation.md
@@ -0,0 +1,17 @@
+**Install**
+
+```bash
+yarn add @0x/migrations
+```
+
+**Import**
+
+```javascript
+import { runMigrationsAsync } from '@0x/migrations';
+```
+
+or
+
+```javascript
+var runMigrationsAsync = require('@0x/migrations').runMigrationsAsync;
+```
diff --git a/packages/website/md/docs/migrations/1/introduction.md b/packages/website/md/docs/migrations/1/introduction.md
new file mode 100644
index 000000000..82ae3a0ab
--- /dev/null
+++ b/packages/website/md/docs/migrations/1/introduction.md
@@ -0,0 +1 @@
+Welcome to the [@0x/migrations](https://github.com/0xProject/0x-monorepo/tree/development/packages/migrations) documentation! This package is intended for developers who would like to deploy the 0x protocol system of smart contracts to a custom testnet. If you want to test against existing testnets, check out our pre-deployed [Ganache snapshot](https://0xproject.com/wiki#Ganache-Setup-Guide) or where 0x is already deployed on [popular testnets](https://0xproject.com/wiki#Deployed-Addresses).