docs

Packages/src/README.md

@@ -17,7 +17,9 @@
 
 ## 📝 Description <!-- omit in toc -->
 
-Decorate your Unity UI (uGUI) with visual effects using UIEffect!
+**_"Bring color to your UI, simply and powerfully."_**  
+UIEffect is an open-source package that allows you to intuitively apply rich UI effects directly from the Inspector or via code.  
+Combine various filters, such as grayscale, blur, and dissolve, to decorate your UI with a unique visual style!
 
 ![](https://github.com/user-attachments/assets/bce4ddb2-766f-4bed-bad2-fda91bb8133c)
 
@@ -37,6 +39,7 @@ Decorate your Unity UI (uGUI) with visual effects using UIEffect!
   - [Component: UIEffectReplica](#component-uieffectreplica)
   - [Usage with TextMeshPro](#usage-with-textmeshpro)
   - [Runtime/Editor Preset for UIEffect](#runtimeeditor-preset-for-uieffect)
+  - [Usage with Code](#usage-with-code)
   - [Project Settings](#project-settings)
   - [:warning: Limitations](#warning-limitations)
 - [🤝 Contributing](#-contributing)
@@ -259,6 +262,28 @@ You can create and use presets for `UIEffect` components.
 
 <br><br>
 
+### Usage with Code
+
+You can control the effect settings and animations via code.
+
+```csharp
+var effect = graphic.AddComponent<UIEffect>();
+
+// Apply a preset
+effect.LoadPreset("Dissolve");
+
+// Set the effect parameters
+effect.transitionWidth = 0.1f;
+effect.transitionColor = Color.red;
+
+// Add a tweener
+var tweener = graphic.AddComponent<UIEffectTweener>();
+tweener.cullingMask = UICullingMask.Tone;
+tweener.wrapMode = UIWrapMode.PingPongLoop;
+```
+
+<br><br>
+
 ### Project Settings
 
 ![](https://github.com/user-attachments/assets/33b01665-0893-4460-a220-62f5f08b2eec)
@@ -280,6 +305,7 @@ You can adjust the project-wide settings for UIEffect. (`Edit > Project Settings
 
 Here are the limitations of UIEffect:
 
+- Shader variants used at runtime must be registered in the [Project Settings](#project-settings).
 - When using UIEffect with TextMeshProUGUI, `SamplingFilter.BlurMedium` and `SamplingFilter.BlurDetail` are not supported due to performance considerations.
   - These will automatically fall back to `SamplingFilter.BlurFast`.