aboutsummaryrefslogtreecommitdiffstats
path: root/packages/website/md/docs/migrations/1
diff options
context:
space:
mode:
authorFabio B <kandinsky454@protonmail.ch>2018-11-22 01:06:32 +0800
committerGitHub <noreply@github.com>2018-11-22 01:06:32 +0800
commit327311788809267a250e99f4af2a7544024bc842 (patch)
tree66a52a9dafda539feba630af3c388189754133b9 /packages/website/md/docs/migrations/1
parent8ea2eb9102058a03d96e488507c71db0cc082356 (diff)
parent61b3305af3a7a599f83370aa8ebe8157738506fb (diff)
downloaddexon-sol-tools-327311788809267a250e99f4af2a7544024bc842.tar
dexon-sol-tools-327311788809267a250e99f4af2a7544024bc842.tar.gz
dexon-sol-tools-327311788809267a250e99f4af2a7544024bc842.tar.bz2
dexon-sol-tools-327311788809267a250e99f4af2a7544024bc842.tar.lz
dexon-sol-tools-327311788809267a250e99f4af2a7544024bc842.tar.xz
dexon-sol-tools-327311788809267a250e99f4af2a7544024bc842.tar.zst
dexon-sol-tools-327311788809267a250e99f4af2a7544024bc842.zip
Merge pull request #1301 from 0xProject/feature/migrationsDocRef
Add Migrations Doc Ref
Diffstat (limited to 'packages/website/md/docs/migrations/1')
-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).