Skip to content

Commit cbb1059

Browse files
committed
Add upgrading notes
1 parent 29d0c48 commit cbb1059

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525

2626
* [Minimum Requirements](#minimum-requirements)
2727
* [Installation](#installation)
28+
* [Upgrading](#upgrading)
2829
* [Usage](#usage)
2930
* [Quick Setup](#quick-setup)
3031
* [Examples](#examples)
@@ -75,6 +76,11 @@
7576
composer require php-school/cli-menu
7677
```
7778

79+
## Upgrading
80+
81+
Please refer to the [Upgrade Documentation](UPGRADE.md) documentation to see what is required to upgrade your installed
82+
`cli-menu` version.
83+
7884
## Usage
7985

8086
### Quick Setup

UPGRADE.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Upgrade Documentation
2+
3+
This document serves as a reference to upgrade your current cli-menu installation if improvements, deprecations
4+
or backwards compatibility (BC) breakages occur.
5+
6+
## 3.0.0
7+
8+
### BC breaks
9+
10+
* Class `PhpSchool\CliMenu\CliMenuBuilder` has been moved, use
11+
`PhpSchool\CliMenu\Builder\CliMenuBuilder` instead. The old class has been aliased for now, but will be removed in
12+
`3.1`.
13+
* Removed `PhpSchool\CliMenu\Terminal` namespace, the code has been migrated to the `php-school/terminal` package and is
14+
largely modified.

0 commit comments

Comments
 (0)