From 72cd17d052b58cb5802e7a96903ad321b3c404ef Mon Sep 17 00:00:00 2001 From: Timon Date: Sun, 12 Aug 2018 12:40:44 +0200 Subject: [PATCH] Update README.md --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 6200a7f..65bdc95 100644 --- a/README.md +++ b/README.md @@ -30,9 +30,7 @@ This crate supports all unix and windows terminals down to windows XP (not not a - [License](https://github.com/TimonPost/crossterm#license) ## IMPORTANT When updating to version `0.3.0` -1. - -Version `0.3.0` of Crossterm will have API braking changes. If you are reading this and your version was automatically incremented to the new version, there will be some broken code. A Quiqe solution? no, unless you did not use this crate that much. If it is important to keep running your code and you don't want to spend some time to fix the errors I recommend you to keep using version `0.2.2` because in version `0.3.0` alternate screen and some other features are introduced. And if you are not using any of these features just downgrade. If however, you want to have the newest version you can check the [upgrade manual](https://github.com/TimonPost/crossterm/blob/master/docs/UpgradeManual.md) on how to upgrade to the new version. Check [release node](https://github.com/TimonPost/crossterm/blob/master/docs/ReleaseNotesVersion%200.3.0.md) why these API breaking changes where necessary. +1. Version `0.3.0` of Crossterm will have API braking changes. If you are reading this and your version was automatically incremented to the new version, there will be some broken code. A Quiqe solution? no, unless you did not use this crate that much. If it is important to keep running your code and you don't want to spend some time to fix the errors I recommend you to keep using version `0.2.2` because in version `0.3.0` alternate screen and some other features are introduced. And if you are not using any of these features just downgrade. If however, you want to have the newest version you can check the [upgrade manual](https://github.com/TimonPost/crossterm/blob/master/docs/UpgradeManual.md) on how to upgrade to the new version. Check [release node](https://github.com/TimonPost/crossterm/blob/master/docs/ReleaseNotesVersion%200.3.0.md) why these API breaking changes where necessary. 2. The next realase 0.4.0 will also have braking changes so to be honnest you could better do'nt upgrade unless you realy want to have the alternate screen and raw screen functionalities. Otherwise you will have dubble work.