admin/topgrade
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: migration and breaking changes (#606)

Browse Source
This commit is contained in:
SteveLauC
2023-11-12 11:43:58 +08:00
committed by GitHub
parent 9ea6628b5c
commit 78dec892cf
1 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -42,15 +42,18 @@ The compiled binaries contain a self-upgrading feature.
Just run `topgrade`. Just run `topgrade`.
Visit the documentation at [topgrade-rs.github.io](https://topgrade-rs.github.io/) for more information.
> **Warning**
> Work in Progress
## Configuration ## Configuration
See `config.example.toml` for an example configuration file. 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 ### Configuration Path
#### `CONFIG_DIR` on each platform #### `CONFIG_DIR` on each platform