summary refs log tree commit diff homepage
diff options
context:
space:
mode:
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index 64abf69..fe48837 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,10 @@
 
 > Connects [Discord](https://discordapp.com/) and [Minecraft](https://minecraft.net) Servers by sending messages back and forth without any mods or plugins.
 
+## Notice
+This project has recently gone under a rewrite and the format for `config.json` is not directly backwards compatible with previous versions.
+See [below](#upgrade-instructions) for details.
+
 ## In Action
 ![discord-mc](http://i.thedestruc7i0n.ca/I5anbg.gif)
 
@@ -97,6 +101,11 @@ You can also easily Deploy to Heroku and the like, just be sure to edit `YOUR_UR
   - Make sure that you have a role on the server which is put in the array `SLASH_COMMAND_ROLES` case-sensitive.
     - e.g. `"SLASH_COMMAND_ROLES": ["Admin"]`
 
+## Upgrade Instructions
+From version 2 to version 3:
+- The main change is that you need to split your `REGEX_MATCH_CHAT_MC` to both `REGEX_MATCH_CHAT_MC` and `REGEX_SERVER_PREFIX`.
+  See the [configuration](#configuration) above for details.
+
 ## Upcoming
 None