From 78dec892cf97013a1123900dcb23cfc2365961e7 Mon Sep 17 00:00:00 2001 From: SteveLauC Date: Sun, 12 Nov 2023 11:43:58 +0800 Subject: [PATCH] docs: migration and breaking changes (#606) --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2204e1ab..f05d6e0d 100644 --- a/README.md +++ b/README.md @@ -42,15 +42,18 @@ The compiled binaries contain a self-upgrading feature. Just run `topgrade`. -Visit the documentation at [topgrade-rs.github.io](https://topgrade-rs.github.io/) for more information. - -> **Warning** -> Work in Progress - ## Configuration See `config.example.toml` for an example configuration file. +## Migration and Breaking Changes + +Whenever there is a **breaking change**, the major version number will be bumped, +and we will document these changes in the release note, please take a look at +it when updated to a major release. + +> Got a question? Feel free to open an issue or discussion! + ### Configuration Path #### `CONFIG_DIR` on each platform