Merge pull request #226 from ckb-devrel/rebase-master

Rebase master

Author: RetricSu

README.md

@@ -6,15 +6,17 @@
 [![npm](https://img.shields.io/npm/l/@offckb/cli.svg?maxAge=1000)](https://github.com/jeffijoe/@offckb/cli/blob/master/LICENSE.md)
 [![node](https://img.shields.io/node/v/@offckb/cli.svg?maxAge=1000)](https://www.npmjs.com/package/@offckb/cli)
 
-**CKB local development network for your first try.**
+CKB local development network for your first try.
 
 - One-line command to start a devnet
 - No docker required
 - Pre-funded test accounts
 - Built-in scripts like [Omnilock](https://github.com/cryptape/omnilock) and [Spore-contract](https://github.com/sporeprotocol/spore-contract)
 - Multiple minimal dApp templates to learn and get your hands dirty
 
-Start building on CKB blockchain, right now, right away!
+**Migrate from v0.2.x to v0.3.x:**
+
+There are BREAKING CHANGES between v0.2.x and v0.3.x, make sure to read the [migration guide](/docs/migration.md) before upgrading.
 
 ## Table of Contents
 

docs/migration.md

@@ -0,0 +1,17 @@
+# Migration from v0.2.x to v0.3.x
+
+## BREAKING CHANGES
+
+1. Rename Devnet chain name in `dev.toml` config from `offckb` to standard `ckb_dev`
+2. Rename `sync-config` to `sync-scripts`
+3. Rename `deployed-scripts` to `my-scripts`
+4. Templates `offckb.config.ts` file are refactored with NEW structure
+
+## Add new commands
+
+1. `proxy-rpc`
+2. `system-scripts`
+3. `debug`
+4. `mol`
+5. `transfer-all`
+6. `repl`

src/cfg/setting.ts

@@ -108,7 +108,7 @@ export const defaultSettings: Settings = {
   },
   dappTemplate: {
     gitRepoUrl: `https://github.com/ckb-devrel/offckb`,
-    gitBranch: 'v0.3.x',
+    gitBranch: 'master',
     gitFolder: 'templates/v3',
     downloadPath: path.resolve(cachePath, 'download', 'dapp-template'),
   },