Added README.md

README.md

@@ -0,0 +1,36 @@
+# OneiroNovel
+Visual Novel Framework for Godot Engine with Ink narrative scripting language.
+
+**Features:**
+- Fully customizable GUI.
+- Ink scripting language for writting stories.
+- Scripting as Ren'Py language. (show, scene, with, at, etc).
+- Backgrounds and sprites as PackedScene.
+- Positioning sprites (at left, at right, at center).
+- TransitionResources: you can write your own shaders and use own transition textures.
+- Audio support.
+- Jumping into other ink story files.
+
+# Installation
+[Download](https://github.com/OneiroGames/OneiroNovel/releases) a latest version of addon, then unzip archive into ```addons/``` path in your project.
+
+**Note:** addon requires [GodotInk](https://github.com/paulloz/godot-ink) and [ExtendableInspectorForCS](https://github.com/ProFiLeR4100/ExtendableInspectorForCS) addons. You 
+need to install it into your project.
+
+# Wiki
+You can find any information about addon in [wiki](https://github.com/OneiroGames/OneiroNovel/wiki).
+
+# TODO
+
+- Mods support
+- Choices
+- Variables, function from ink to CS/GD
+- GDScript binding
+
+# Donate
+For donating you can use [boosty](https://boosty.to/dezlowng).
+
+# Assets used in demo
+- [Backgrounds](https://noranekogames.itch.io/yumebackground)
+- [Sprites](https://noranekogames.itch.io/rin)
+- [Music](https://lesser-vibes.com/)