From bb676b9696343a060e663d5302948bee3c8dc296 Mon Sep 17 00:00:00 2001
From: Dex <dav.medrin@gmail.com>
Date: Wed, 17 Nov 2021 20:42:06 +0000
Subject: [PATCH] GitBook: [#1] Add changelog page

---
 README.md => docs/README.md | 39 +++++++++++++++++--------------------
 docs/SUMMARY.md             |  3 ++-
 docs/changelog.md           |  2 ++
 3 files changed, 22 insertions(+), 22 deletions(-)
 rename README.md => docs/README.md (66%)
 create mode 100644 docs/changelog.md

diff --git a/README.md b/docs/README.md
similarity index 66%
rename from README.md
rename to docs/README.md
index ba7e8bd2..77a7c881 100644
--- a/README.md
+++ b/docs/README.md
@@ -1,46 +1,43 @@
-# Textalog - A DialogSystem Plugin for Godot Engine
-[![Godot Engine](https://img.shields.io/badge/Godot%20Engine-Plugin-blue?style=flat-square&logo=godot-engine&logoColor=white&logoWidth=20)]() [![GitHub license](https://img.shields.io/github/license/AnidemDex/Godot-DialogPlugin?style=flat-square)](https://github.com/AnidemDex/Godot-DialogPlugin/blob/main/LICENSE)
-[![GitHub issues](https://img.shields.io/github/issues/AnidemDex/Godot-DialogPlugin?style=flat-square)](https://github.com/AnidemDex/Godot-DialogPlugin/issues)
-[![Godot Engine](https://img.shields.io/badge/Version-1.0-Green?style=flat-square)](https://github.com/AnidemDex/Godot-DialogPlugin/releases/tag/v1.0)
+# 🧐 What is EventSystem?
 
-<p align="center">
-  <a href="https://twitter.com/anidemdex" target="_blank"><img src="https://raw.githubusercontent.com/AnidemDex/Godot-DialogPlugin/main/.images/banner_animation.gif"></a><br/>
-  Twitter: <a href="https://twitter.com/anidemdex" target="_blank">@AnidemDex</a>
-</p>
+[![Godot Engine](https://img.shields.io/badge/Godot%20Engine-Plugin-blue?style=flat-square\&logo=godot-engine\&logoColor=white\&logoWidth=20)](./) [![GitHub license](https://img.shields.io/github/license/AnidemDex/Godot-DialogPlugin?style=flat-square)](../LICENSE/) [![GitHub issues](https://img.shields.io/github/issues/AnidemDex/Godot-DialogPlugin?style=flat-square)](https://github.com/AnidemDex/Godot-DialogPlugin/issues) [![Godot Engine](https://img.shields.io/badge/Version-1.0-Green?style=flat-square)](https://github.com/AnidemDex/Godot-DialogPlugin/releases/tag/v1.0)
 
-An user-friendly dialog system for Godot Engine with characters, text boxes, dialog bubbles and many more (planned) features for your games. 
+[![](https://raw.githubusercontent.com/AnidemDex/Godot-DialogPlugin/main/.images/banner\_animation.gif)](https://twitter.com/anidemdex)\
+Twitter: [@AnidemDex](https://twitter.com/anidemdex)
 
-> **Note:** _If you find a bug, or want a feature to be included, feel free to [open a new issue](https://github.com/AnidemDex/Godot-DialogPlugin/issues/new). You can also send me a message on [twitter](https://twitter.com/anidemdex) or [join us on Discord](https://discord.gg/83YgrKgSZX)._
+An user-friendly dialog system for Godot Engine with characters, text boxes, dialog bubbles and many more (planned) features for your games.
 
+> **Note:** _If you find a bug, or want a feature to be included, feel free to _[_open a new issue_](https://github.com/AnidemDex/Godot-DialogPlugin/issues/new)_. You can also send me a message on _[_twitter_](https://twitter.com/anidemdex)_ or _[_join us on Discord_](https://discord.gg/83YgrKgSZX)_._
 
 ## Features
+
 ### 🪧 DialogNode and 🗨️ DialogBubble
+
 A node implementation for dialog box and dialog bubble, fully customizable and build with common dialog commands to improve your game development in the dialogue interaction.
 
-- DialogNode
-![DialogNode](./docs/.gitbook/assets/dialog_box_example_1.png)
+* DialogNode ![DialogNode](.gitbook/assets/dialog\_box\_example\_1.png)
+* DialogBubble
 
-- DialogBubble
-<p align="center">
-  <img src="./docs/.gitbook/assets/dialog_bubble_example_1.png">
-</p>
+![](.gitbook/assets/dialog\_bubble\_example\_1.png)
 
 ### 🐱‍👤 Characters and 🖼️ Portraits
+
 Characters are data containers to describe what expressions (portraits) are going to be used in dialogue and what properties of the dialogue will be overriden during the gameplay.
 
-<!--TODO: Add an image here-->
 ## 🚩 Installation
 
 Download the lastest release and extract the ZIP file. Move the `addons` folders to the root of your project. Finally, enable the plugin in your project settings, under `plugins` tab. It's that easy!
 
 > You can take a look in a more detailed tutorial in the [plugin's documentation](https://godotplugins.gitbook.io/textalog/getting-started/installation).
 
-If you want more information about installing plugins in Godot, please refer to [official documentation page](https://docs.godotengine.org/en/stable/tutorials/plugins/editor/installing_plugins.html).
+If you want more information about installing plugins in Godot, please refer to [official documentation page](https://docs.godotengine.org/en/stable/tutorials/plugins/editor/installing\_plugins.html).
 
 If you're downloading the repository instead, make sure to move only `textalog` to your `addons` folder. Extra files and folders are for debug purposes.
 
 ## 🧵 Usage
+
 Quick example to try the most simple functionality: showing text on the screen.
+
 ```gdscript
 func _ready() -> void:
   # Creates a new DialogNode instance
@@ -56,7 +53,7 @@ func _ready() -> void:
   dialog_node.show_text("Hello world!")
 ```
 
-## 🔎 What is new on this version? [1.0]
+## 🔎 What is new on this version? \[1.0]
 
 This is the first stable release _(yay 🥳)_. To manage to release this, many things were removed to add them later on 1.x versions (like, the timelines).
 
@@ -72,7 +69,6 @@ This is the first stable release _(yay 🥳)_. To manage to release this, many t
 * Removed:
   * **Literally everything from `dialog_plugin` folder**. Take a look on previous pre-release versions to see what exactly were removed. Those features will be reimplemented in future minor versions.
 
-
 Want to see the whole changelog? Take a look on the documentation, the [Changelog](https://anidemdex.gitbook.io/godot-dialog-plugin/changelog) section.
 
 ## 📚 Documentation
@@ -80,6 +76,7 @@ Want to see the whole changelog? Take a look on the documentation, the [Changelo
 Now we have an official documentation! All the information about the plugin you will find it organized in the [documentation page](https://anidemdex.gitbook.io/godot-dialog-plugin/). Tutorials, class information, FAQ and more will be added there, eventually.
 
 ## 📝Credits and license
+
 Made by [AnidemDex](https://github.com/anidemDex)
 
-This plugin uses [MIT license](./LICENSE)
+This plugin uses [MIT license](../LICENSE/)
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
index 926aa131..a6da2926 100644
--- a/docs/SUMMARY.md
+++ b/docs/SUMMARY.md
@@ -1,3 +1,4 @@
 # Table of contents
 
-* [🧐 What is EventSystem?](../README.md)
+* [🧐 What is EventSystem?](README.md)
+* [Changelog](changelog.md)
diff --git a/docs/changelog.md b/docs/changelog.md
new file mode 100644
index 00000000..4dc68c6f
--- /dev/null
+++ b/docs/changelog.md
@@ -0,0 +1,2 @@
+# Changelog
+