diff --git a/README.md b/README.md
index 48652b8..f0cf725 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,67 @@
-# Espanso
\ No newline at end of file
+![espanso](images/titlebar.png)
+
+> A cross-platform Text Expander written in Rust
+
+![Language](https://img.shields.io/badge/language-rust-orange)
+![Platforms](https://img.shields.io/badge/platforms-Windows%2C%20macOS%20and%20Linux-blue)
+![License](https://img.shields.io/github/license/federico-terzi/espanso)
+
+![example](images/example.gif)
+
+#### What is a Text Expander?
+
+A *text expander* is a program that detects when you type
+a specific **keyword** and replaces it with **something else**.
+This is useful in many ways:
+* **Save a lot of typing**, expanding common sentences.
+* Create **system-wide** code snippets.
+* Execute **custom scripts**
+* Use **emojis** like a pro.
+
+___
+
+## Key Features
+
+* Works on **Windows**, **macOS** and **Linux**
+* Works with almost **any program**
+* Works with **Emojis** 😄
+* **Date** expansion support
+* **Custom scripts** support
+* **Shell commands** support
+* **App-specific** configurations
+* File based configuration
+
+## Table of contents
+
+- [Installation](#installation)
+ - [Windows](#install-windows)
+ - [Linux](#install-linux)
+ - [macOS](#install-macos)
+- [FAQ](#faq)
+- [Donations](#donations)
+- [License](#license)
+
+## Installation
+
+### Windows
+
+### Linux
+
+### MacOS
+
+## FAQ
+
+
+
+## Donations
+
+espanso is a free, open source software developed in my (little) spare time.
+If you liked the project and would like to support further development,
+please consider making a small donation, it really helps :)
+
+[![Donate with PayPal](images/donate.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=FHNLR5DRS267E&source=url)
+
+## License
+
+espanso was created by [Federico Terzi](http://federicoterzi.com)
+and is licensed under the [GPL-3.0 license](/LICENSE).
\ No newline at end of file
diff --git a/images/donate.gif b/images/donate.gif
new file mode 100644
index 0000000..d91cb49
Binary files /dev/null and b/images/donate.gif differ
diff --git a/images/example.gif b/images/example.gif
new file mode 100644
index 0000000..cb08403
Binary files /dev/null and b/images/example.gif differ
diff --git a/images/icongreensmall.png b/images/icongreensmall.png
new file mode 100644
index 0000000..9bde0d2
Binary files /dev/null and b/images/icongreensmall.png differ
diff --git a/images/titlebar.png b/images/titlebar.png
new file mode 100644
index 0000000..5769989
Binary files /dev/null and b/images/titlebar.png differ
diff --git a/src/res/config.yaml b/src/res/config.yaml
index 906bbd9..af10305 100644
--- a/src/res/config.yaml
+++ b/src/res/config.yaml
@@ -2,14 +2,33 @@
# This is the default configuration file, change it as you like it
# You can refer to the official documentation:
+# https://github.com/federico-terzi/espanso
# Matches are the substitution rules, when you type the "trigger" string
# it gets replaced by the "replace" string.
matches:
- # Default
+ # Simple text replacement
- trigger: ":espanso"
replace: "Hi there!"
+ # Dates
+ - trigger: ":date"
+ replace: "{{mydate}}"
+ vars:
+ - name: mydate
+ type: date
+ params:
+ format: "%m/%d/%Y"
+
+ # Shell commands
+ - trigger: ":shell"
+ replace: "{{output}}"
+ vars:
+ - name: output
+ type: shell
+ params:
+ cmd: "echo Hello from you shell"
+
# Emojis
- trigger: ":lol"
replace: "😂"
@@ -21,29 +40,21 @@ matches:
replace: "☹☹☹☹"
# Accented letters
- - trigger: "e'"
+ - trigger: "e''"
replace: "è"
- trigger: "e//"
replace: "é"
- - trigger: "a'"
+ - trigger: "a''"
replace: "Ã "
- - trigger: "i'"
+ - trigger: "i''"
replace: "ì"
- - trigger: "o'"
+ - trigger: "o''"
replace: "ò"
- - trigger: "u'"
+ - trigger: "u''"
replace: "ù"
# Capital accented letters
- - trigger: "E'"
+ - trigger: "E''"
replace: "È"
- - trigger: "E/"
- replace: "É"
- - trigger: "A'"
- replace: "À"
- - trigger: "I'"
- replace: "Ì"
- - trigger: "O'"
- replace: "Ã’"
- - trigger: "U'"
- replace: "Ù"
\ No newline at end of file
+ - trigger: "E//"
+ replace: "É"
\ No newline at end of file