From 888b10b5d3cf659ebe1df2a96d92785ab8111b3c Mon Sep 17 00:00:00 2001 From: Joel Gomes da Silva Date: Sun, 25 Aug 2024 10:10:03 -0300 Subject: [PATCH] doc: add index to readme --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index dc41666..ccf37f8 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,21 @@ See the example scene on `addons/simple-gui-transitions/example` to see this plu [Download it on Godot Asset Library](https://godotengine.org/asset-library/asset/2134) +## Index +- [Index](#index) +- [Installation](#installation) +- [Basic Usage](#basic-usage) + - [Node Configuration](#node-configuration) + - [Triggering Transitions](#triggering-transitions) + - [Known Limitations](#known-limitations) +- [Global Settings](#global-settings) +- [Node `GuiTransition`](#node-guitransition) + - [Properties](#properties) +- [Singleton `GuiTransitions`](#singleton-guitransitions) + - [Signals](#signals) + - [Public Methods](#public-methods) + + ## Installation - Install the plugin through the [AssetLib](https://godotengine.org/asset-library/asset/2134) **or** copy the plugin `addons` folder to your project's directory - Enable the plugin on `Project > Project Settings > Plugins`