From a961ba5e50b91d167b43effa42b491666b6e4720 Mon Sep 17 00:00:00 2001
From: Eptwalabha <damiengabrielle@gmail.com>
Date: Tue, 25 Feb 2020 00:38:29 +0100
Subject: [PATCH] update README.md

---
 README.md | 131 ++++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 103 insertions(+), 28 deletions(-)

diff --git a/README.md b/README.md
index 4640390..44c2371 100644
--- a/README.md
+++ b/README.md
@@ -1,25 +1,16 @@
-# Dialink
-A Godot 3.2 plugin to easily handle dialogs in your game
+# Dialink :)![dialink icon](https://raw.githubusercontent.com/Eptwalabha/godot-dialink/master/icon.png)  
+A Godot 3.2 plugin to easily handle dialogs in your game.
 
-## What this plugin isn't
-- A node to display dialogs
-- A dialog editor
-
-## Then what is it for?
-This plugin is useful if your game needs to handle multiple dialogs with multiple choices (or simple linear dialog as well ;) ), it event handles conditional branching.
-The new `DialogSystem` node will handle the logic of your dialogs by returning what to display next.  
-Once your dialogs are defined in the new node, you'll just have to call:
-``` GDscript
-my_dialog_system.start("my-dialogt")
-var current_dialog = my_dialog_system.next()
-# or if the dialog offers multiple choices
-var current_dialog = my_dialog_system.choice_next(user_choice)
-```
-
-# Licence
-`Dialink` is provided under the MIT License.
+# What this plugin isn't
+- This plugin **is not** a Nod2D nor a Control node that will display dialogs
+- This plugin **is not** (yet) a dialog editor
 
+# Then what is it?
+This plugin is useful if your game needs to handle multiple dialogs with multiple choices and/or conditional branching (it also handles simple linear dialog as well ;) ).  
+Under the hood, the new `DialogSystem` node will take care of the logic of your dialogs.  
+Once everything's setup, you just have to ask the node what to display next.  
 # Install
+## From github:
 Download / clone the project somewhere on your computer
 ``` bash
 git clone git@github.com:Eptwalabha/godot-dialink.git
@@ -27,16 +18,100 @@ git clone git@github.com:Eptwalabha/godot-dialink.git
 Then copy the `addons/dialink` directory into the `addons` directory of your project.  
 Finaly, activate the plugin `Project`>`Project Settings`>`Plugins`.
 
-# How to
+## From the Godot asset library
+The plugin was submitted to the asset library but has not yet been approved.  
+I'll update this section once the plugin's available on the plateform.
+
+# Quick tutorial
+
+## Add the new `DialogSystem` node to your scene:
 Once the plugin is activated, you should see a new `DialogSystem` node in the node list with the following icon:  
 ![dialink icon](https://raw.githubusercontent.com/Eptwalabha/godot-dialink/master/icon.png)  
-Add it to your Scene (If needed, you can add more).  
-In order to work, you need to provide to the new node with a JSON file where all your dialogs are defined.
+Add it to your Scene (you can add more than one).  
+
+## Setup the new node
+In order to work, you need to provide to the new node with a JSON file. This file is where all your dialogs are defined.
+For the sake of this tutorial, we'll use the following JSON file (`my-simple-dialog.json`):
+``` json
+{
+    "dialogs": {
+        "hello-world": [
+            {
+                "text": "Hello my friend."
+            },
+            {
+                "text": "How are you?",
+                "choices": [
+                    {
+                        "text": "Fine, and you?",
+                        "then": [
+                            { "text": "Very well" }
+                        ]
+                    },
+                    {
+                        "text": "I'm not feeling very well today",
+                        "then": [
+                            { "text": "Too bad" }
+                        ]
+                    }
+                ]
+            }
+        ]
+    }
+}
+```
+Seting up a new node is as simple as:
+``` gdscript
+var dialogs = $DialogSystem
+# setup the json file containing all your game dialogs
+# (this can also be done directly from the editor's inspector)
+dialogs.dialog_file = 'res://my-simple-dialog.json'
+# let start the dialog named 'hello-world'
+dialogs.start("hello-world")
+```
+That's it, you're all setup!
 
-# Example:
-See [Simple.gd](https://github.com/Eptwalabha/godot-dialink/blob/master/Simple.gd) to have an idea on how to use the node.
+## Let's chat a bit  
+If you want to know what dialog to display next, you just have to call the `next()` function:
+``` gdscript
+var dialog_content = dialogs.next()
+```
+This will return a `Dictionary` containing the current line of dialog to display on screen.
+``` gdscript
+{
+    'text': "Hello my friend."
+}
+```
+Calling `next()` again will return the choices you need to display to your player:
+``` gdscript
+{
+    'text': "How are you?",
+    'choices': [
+        {
+            'id': 0,
+            'text': "Fine, thank you"
+        },
+        {
+            'id': 1,
+            'text': "I'm not feeling very well today"
+        }
+    ]
+}
+```
+Call the `choice_next(id)` function once your player has choosen what to answer:
+``` gdscript
+# let's say the player picked the second choice with the `id` = 1
+dialog_content = dialogs.choice_next(1)
+```
+Now `dialog_content` contains the next line of dialog to display:
+``` gdscript
+{
+    "text": "Too bad"
+}
+```
+
+This is only a simple example, this node can do much much more
+
+# Licence
+`Dialink` is provided under the MIT License.
 
-# Structure of the JSON file
-I'm currently working on a Wiki to explain how to write your dialogs.  
-That said, if you're not afraid of diving in the code, you should check all the unit tests.  
-The JSON file [example.json](https://github.com/Eptwalabha/godot-dialink/blob/master/example.json) is also a nice place to start