Add ChangeLog and update UPGRADE.md

BitAndBlack · Apr 11, 2023 · 7d4e7b0 · 7d4e7b0
1 parent 38ca4a2
commit 7d4e7b0
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 1 deletion.
diff --git a/ChangeLog-2.1.md b/ChangeLog-2.1.md
@@ -4,4 +4,4 @@
 
 ### Changed 
 
-- A lot of method names have been refactored to match the coding conventions of [PSR-1](https://www.php-fig.org/psr/psr-1/) and [PSR-12](https://www.php-fig.org/psr/psr-12/). For example `phase_name()` is now `getPhaseName()`. Methods with parameters have been split, for example `get_phase('new_moon')` is now `getPhaseNewMoon()`. Old methods are still available and can be used anyway. They will be removed in v3.0. To inform about those changes, deprecation messages have been added.
+-   A lot of method names have been refactored to match the coding conventions of [PSR-1](https://www.php-fig.org/psr/psr-1/) and [PSR-12](https://www.php-fig.org/psr/psr-12/). For example `phase_name()` is now `getPhaseName()`. Methods with parameters have been split, for example `get_phase('new_moon')` is now `getPhaseNewMoon()`. Old methods are still available and can be used anyway. They will be removed in `v3.0`. To inform about those changes, deprecation messages have been added.
diff --git a/ChangeLog-3.0.md b/ChangeLog-3.0.md
@@ -0,0 +1,9 @@
+# Changes in Solaris Moon Phase v3.0
+
+## 3.0.0 2023-04-11
+
+### Changed 
+
+-   The library now requires at least PHP `8.2`.
+-   Some internal methods and properties have been renamed.
+-   Deprecated methods have been removed.
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -1,5 +1,18 @@
 # Upgrades
 
+## 2.x to 3.0
+
+In `v3.0` some internal methods and properties have been renamed. This should only affect you, if you are extending the MoonPhase class.
+
+Additionally, some deprecated methods have been removed. If you were still using them, please make sure to
+
+-   replace `phase_name()` with `getPhaseName()`,
+-   change `get_phase()` with one of its replacing getters. For example if you are using `get_phase('new_moon')`, the new method is `getPhaseNewMoon()`,
+-   replace `get()` with another getter method,
+-   replace `phase()` with `getPhase()`.
+
+The read more about those changes, see [ChangeLog-2.1.md](./ChangeLog-2.1.md).
+
 ## 1.x to 2.0
 
 The `v2.0` release does not add any new features and does not remove any. Instead, some changes have been made to bring the library up to current standards:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,4 +4,4 @@

		### Changed

		- A lot of method names have been refactored to match the coding conventions of [PSR-1](https://www.php-fig.org/psr/psr-1/) and [PSR-12](https://www.php-fig.org/psr/psr-12/). For example `phase_name()` is now `getPhaseName()`. Methods with parameters have been split, for example `get_phase('new_moon')` is now `getPhaseNewMoon()`. Old methods are still available and can be used anyway. They will be removed in v3.0. To inform about those changes, deprecation messages have been added.
		- A lot of method names have been refactored to match the coding conventions of [PSR-1](https://www.php-fig.org/psr/psr-1/) and [PSR-12](https://www.php-fig.org/psr/psr-12/). For example `phase_name()` is now `getPhaseName()`. Methods with parameters have been split, for example `get_phase('new_moon')` is now `getPhaseNewMoon()`. Old methods are still available and can be used anyway. They will be removed in `v3.0`. To inform about those changes, deprecation messages have been added.