Improve readme
This commit is contained in:
parent
3e00f3c3f2
commit
05ec624c29
27
README.md
27
README.md
|
@ -1,18 +1,30 @@
|
||||||
|
<img src="/images/icongreensmall.png" align="right" />
|
||||||
|
|
||||||
# espanso
|
# espanso
|
||||||
|
|
||||||
Cross-platform Text Expander written in Rust
|
> Cross-platform Text Expander written in Rust
|
||||||
|
|
||||||
![example](/images/example.gif)
|
![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 snippets and sentences.
|
||||||
|
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
|
|
||||||
* Works on Windows, MacOS and Linux
|
* Works on **Windows**, **macOS** and **Linux**
|
||||||
* Works with almost any program
|
* Works with almost **any** program
|
||||||
* Works with Emojis
|
* Works with **Emojis** 😄
|
||||||
|
* **Date** expansion support
|
||||||
|
* **Custom scripts** support
|
||||||
|
* **Shell commands** support
|
||||||
|
* **App-specific** configurations
|
||||||
* File based configuration
|
* File based configuration
|
||||||
|
|
||||||
### What is a Text Expander?
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
|
@ -23,4 +35,5 @@ Cross-platform Text Expander written in Rust
|
||||||
|
|
||||||
### License
|
### License
|
||||||
|
|
||||||
espanso is licensed under the [GPL-3.0 license](/LICENSE).
|
espanso was created by [Federico Terzi](http://federicoterzi.com)
|
||||||
|
and is licensed under the [GPL-3.0 license](/LICENSE).
|
BIN
images/icongreensmall.png
Normal file
BIN
images/icongreensmall.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 11 KiB |
Loading…
Reference in New Issue
Block a user