Skip to content

Commit 81e5ebf

Browse files
committed
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 <[email protected]>
1 parent 645f38c commit 81e5ebf

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,12 +114,19 @@ If you are upgrading HackMD from an older version, follow these steps:
114114
6. Run `node_modules/.bin/sequelize db:migrate`, this step will migrate your db to the latest schema
115115
7. Start your whole new server!
116116

117-
* [migration-to-0.5.0](https://github.com/hackmdio/migration-to-0.5.0)
117+
118+
* **migrate-to-1.1.0**
119+
120+
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.
121+
122+
*Notice: This is not a breaking change right now but in the future*
123+
124+
* [**migration-to-0.5.0**](https://github.com/hackmdio/migration-to-0.5.0)
118125

119126
We don't use LZString to compress socket.io data and DB data after version 0.5.0.
120127
Please run the migration tool if you're upgrading from the old version.
121128

122-
* [migration-to-0.4.0](https://github.com/hackmdio/migration-to-0.4.0)
129+
* [**migration-to-0.4.0**](https://github.com/hackmdio/migration-to-0.4.0)
123130

124131
We've dropped MongoDB after version 0.4.0.
125132
So here is the migration tool for you to transfer the old DB data to the new DB.

0 commit comments

Comments
 (0)