Document changes

Author: spawnia

CHANGELOG.md

@@ -10,6 +10,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - Require composer/class-map-generator over composer/composer [268](https://github.com/BenSampo/laravel-enum/pull/268)
+- Use native types whenever possible
+- Throw when calling `Enum::getDescription()` with invalid values
+- Expect class-string in `InvalidEnumMemberException` constructor
+
+### Fixed
+
+- Leverage late static binding for instantiation methods in PHPStan extension
 
 ## [5.3.1](https://github.com/BenSampo/laravel-enum/compare/v5.3.0...v5.3.1) - 2022-06-22
 

LICENCE.txt LICENSE.txt

@@ -49,7 +49,7 @@ Created by [Ben Sampson](https://sampo.co.uk)
 
 ## Documentation for older versions
 
-You are reading the documentation for `5.x`.
+You are reading the documentation for `6.x`.
 
 - If you're using **Laravel 8** please see the [docs for `4.x`](https://github.com/BenSampo/laravel-enum/blob/v4.2.0/README.md).
 - If you're using **Laravel 7** please see the [docs for `2.x`](https://github.com/BenSampo/laravel-enum/blob/v2.2.0/README.md).
@@ -109,7 +109,7 @@ final class UserType extends Enum
 ```
 
 That's it! Note that because the enum values are defined as plain constants,
-you can simple access them like any other class constant.
+you can simply access them like any other class constant.
 
 ```php
 UserType::Administrator // Has a value of 0

README.md

@@ -1,5 +1,22 @@
 # Upgrade Guide
 
+## 6.x
+
+### Native types
+
+The library now uses native types whenever possible.
+When you override methods or implement interfaces, you will need to add them.
+
+### `Enum::getDescription()` throws
+
+Instead of returning an empty string `''` on invalid values,
+`Enum::getDescription()` will throw an `InvalidEnumMemberException`.
+
+### Construct `InvalidEnumMemberException`
+
+The constructor of `InvalidEnumMemberException` now expects the class name
+of an enum instead of an enum instance.
+
 ## 5.x
 
 ### Laravel 9 required