diff --git a/README.md b/README.md index 0a72a2a..f0cf725 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ![espanso](images/titlebar.png) -> Cross-platform Text Expander written in Rust +> 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) @@ -8,7 +8,7 @@ ![example](images/example.gif) -##### What is a Text Expander? +#### 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**. @@ -18,7 +18,9 @@ This is useful in many ways: * Execute **custom scripts** * Use **emojis** like a pro. -### Features +___ + +## Key Features * Works on **Windows**, **macOS** and **Linux** * Works with almost **any program** 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