Skip to content

Commit

Permalink
doc: add index to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
joelgomes1994 committed Aug 25, 2024
1 parent 230e2e2 commit 888b10b
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down

0 comments on commit 888b10b

Please sign in to comment.