diff --git a/Packages/src/README.md b/Packages/src/README.md index 66b7533..e766976 100644 --- a/Packages/src/README.md +++ b/Packages/src/README.md @@ -11,7 +11,7 @@ [![](https://img.shields.io/github/watchers/mob-sakai/ParticleEffectForUGUI.svg?style=social&label=Watch)](https://github.com/mob-sakai/ParticleEffectForUGUI/subscription) [![](https://img.shields.io/twitter/follow/mob_sakai.svg?label=Follow&style=social)](https://twitter.com/intent/follow?screen_name=mob_sakai) -<< [📝 Description](#-description-) | [📌 Key Features](#-key-features) | [🎮 Demo](#-demo) | [⚙ Installation](#-installation) | [🚀 Usage](#-usage) | [🛠 Development Note](#-development-note) | [🤝 Contributing](#-contributing) >> +<< [📝 Description](#-description-) | [📌 Key Features](#-key-features) | [🎮 Demo](#-demo) | [⚙ Installation](#-installation) | [🔄 Upgrading to 5.x](#-upgrading-from-3x4x-to-5x) | [🚀 Usage](#-usage) | [🛠 Development Note](#-development-note) | [🤝 Contributing](#-contributing) >> ## 📝 Description @@ -27,6 +27,8 @@ You can render, mask, and sort your `ParticleSystems` for UI without the need fo - [Install via UPM (with Package Manager UI)](#install-via-upm-with-package-manager-ui) - [Install via UPM (Manually)](#install-via-upm-manually) - [Install as Embedded Package](#install-as-embedded-package) +- [🔄 Upgrading from 3.x/4.x to 5.x](#-upgrading-from-3x4x-to-5x) + - [Breaking Changes](#breaking-changes) - [🚀 Usage](#-usage) - [Component: UIParticle](#component-uiparticle) - [Basic Usage](#basic-usage) @@ -151,6 +153,17 @@ _This package requires **Unity 2018.3 or later**._

+## 🔄 Upgrading from 3.x/4.x to 5.x + +### Breaking Changes + +- The default value of `UIParticle.scale` has been changed from `10` to `1`. +- `UIParticle` no longer inherits from `MaskableGraphic`. +- Add project settings for UIParticle + - enableLinearToGamma: Enables LinearToGamma during mesh baking + +

+ ## 🚀 Usage ### Component: UIParticle