feat: initial version of the README

README.md

@@ -0,0 +1,58 @@
+<p align="center">
+<img style="height: 120px; object-fit: cover" src="https://user-images.githubusercontent.com/3514405/143497096-e5d98c85-1f1b-4d8a-9a63-ee439d4c616d.png" /> 
+<p align="center" style="font-style: italic"> The friendly tool for writing game dialogue, in and for Godot</p>
+</p> 
+
+---
+
+**Wol** is a tool for creating interactive dialogue for games. Its based on [YarnSpinner](https://yarnspinner.dev/) and it's Yarn language. 
+
+Write your conversations in *Yarn*, a simple programming language that's designed to be easy for writers to learn, while also powerful enough to handle whatever you need. 
+
+Yarn's similar in style to [Twine](http://twinery.org), so if you already know that, you'll be right at home! If you don't, that's cool - Yarn's syntax is extremely minimal, and there's not much there to learn. 
+
+## Getting Started
+
+This repo contains the source code for the Wol compiler. If you want to use it in a game engine other than Godot, you should get the appropriate package for your game engine.
+
+* ~**Download Wol in Godot's AssetLib**~ (not available yet)
+* **[Yarn Spinner for Unity](https://github.com/YarnSpinnerTool/YarnSpinner-Unity/releases/latest)** (2018.4 LTS or later)
+
+Once you've downloaded it, head over to the ~[tutorial](#)~! (Currently under construction)
+
+## Roadmap
+
+There are few things that need to be ironed out to be 100% feature compatible with the original YarnSpinner.
+
+- [ ] Integration with Godot's translation/localization system.
+- [ ] Full support for [format functions](https://yarnspinner.dev/docs/syntax/#format-functions).
+- [ ] In-editor dialogue editor with preview.
+- [x] Porting to usable signals in Godot.
+- [x] Providing helpful errors when failing to compile.
+
+## Getting Help
+
+There are several places to get help with Wol, and stay up to date with what's happening.
+
+* [Follow me on Twitter](https://twitter.com/bram_dingelstad) or [@ me](https://twitter.com/intent/tweet?text=Hey%20@bram_dingelstad,%20I%20need%20help%20using%20%23Wol%21)!
+* Open an issue on [Github](https://github.com/bram-dingelstad/Wol/issues)!
+
+## License
+
+Wol is available under the [MIT License](LICENSE.md). This means that you can use it in any commercial or noncommercial project. The only requirement is that you need to include attribution in your game's docs. A credit would be very, very nice, too, but isn't required. If you'd like to know more about what this license lets you do, tldrlegal.com have a [very nice write up about the MIT license](https://tldrlegal.com/license/mit-license) that you might find useful.
+
+## Made by Bram Dingelstad, kyperbelt & Secret Lab
+
+Yarn Spinner was originally created by [Secret Lab](http://secretlab.com.au), an Australian game dev studio. [Say hi to them for me!](https://twitter.com/thesecretlab)!
+
+Started on Godot by [kyperbelt](https://github.com/kyperbelt/GDYarn) (thank you so much for the initial work!) and completed by Bram Dingelstad. [Say hi to me as well! ](bram.dingelstad.works/)!
+
+
+## Help Me Make Wol & Secret Lab's Yarn Spinner!
+
+Wol & Yarn Spinner needs your help to be as awesome as it can be! You don't have to be a coder to help out - we'd love to have your help in improving this or YarnSpinner's [documentation](https://yarnspinner.dev/docs/tutorial), in spreading the word, and in finding bugs.
+
+* Yarn Spinner's development is powered by our wonderful Patreon supporters. [Become a patron](https://patreon.com/secretlab), and help us make Yarn Spinner be amazing.
+* The [issues page](https://github.com/bram-dingelstad/Wol/issues) contains a list of things we'd love your help in improving.
+* Join Secret Lab's discussion on Slack by joining the [narrative game development](http://lab.to/narrativegamedev) channel.
+* Follow [Bram Dingelstad](https://twitter.com/bram_dingelstad) [Yarn Spinner](http://twitter.com/YarnSpinnerTool).