add Migration guide (#118)

wechaty · Jan 23, 2021 · 223209d · 223209d
1 parent 33f7a32
commit 223209d
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -7,6 +7,17 @@ please use **wechaty-puppet-service** instead.
 
 ## Use **wechaty-puppet-service** instead of ~~wechaty-puppet-hostie~~
 
+### Migration Guide
+
+1. Replace `wechaty-puppet-hostie` by `wechaty-puppet-service`
+1. Replace `WECHATY_PUPPET_HOSTIE_TOKEN` by `WECHATY_PUPPET_SERVICE_TOKEN`
+1. Replace `PuppetHostie` by `PuppetService` (if applicatory)
+1. Replace `WECHATY_PUPPET_HOSTIE_ENDPOINT` by `WECHATY_PUPPET_SERVICE_ENDPOINT` (if applicatory)
+
+If you have any questions, please feel free to ask in our Gitter room: <https://gitter.im/wechaty/wechaty>
+
+-----
+
 [![NPM Version](https://badge.fury.io/js/wechaty-puppet-hostie.svg)](https://www.npmjs.com/package/wechaty-puppet-hostie)
 [![NPM](https://github.com/Chatie/grpc/workflows/NPM/badge.svg)](https://github.com/wechaty/wechaty-puppet-hostie/actions?query=workflow%3ANPM)