summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSheogorath2018-04-05 01:21:20 +0200
committerSheogorath2018-04-06 02:20:34 +0200
commit81e5ebf6d6caf78bd820e9d087b6301c78196dd3 (patch)
tree99e1a4afe05e03cbc93f2c83156eeeac36b3e49b
parent645f38c2280224b163dafb1a2979f00999390ce9 (diff)
Add migration section to README.md
As it was requested to be more visable, this commit adds a migration section about the introduced config style changes. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
Diffstat (limited to '')
-rw-r--r--README.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/README.md b/README.md
index 0bb3845b..ed0cc029 100644
--- a/README.md
+++ b/README.md
@@ -114,12 +114,19 @@ If you are upgrading HackMD from an older version, follow these steps:
6. Run `node_modules/.bin/sequelize db:migrate`, this step will migrate your db to the latest schema
7. Start your whole new server!
-* [migration-to-0.5.0](https://github.com/hackmdio/migration-to-0.5.0)
+
+* **migrate-to-1.1.0**
+
+We deprecated the older lower case config style and moved on to camel case style. Please have a look at the current `config.json.example` and check the warnings on startup.
+
+*Notice: This is not a breaking change right now but in the future*
+
+* [**migration-to-0.5.0**](https://github.com/hackmdio/migration-to-0.5.0)
We don't use LZString to compress socket.io data and DB data after version 0.5.0.
Please run the migration tool if you're upgrading from the old version.
-* [migration-to-0.4.0](https://github.com/hackmdio/migration-to-0.4.0)
+* [**migration-to-0.4.0**](https://github.com/hackmdio/migration-to-0.4.0)
We've dropped MongoDB after version 0.4.0.
So here is the migration tool for you to transfer the old DB data to the new DB.