Improve readme

This commit is contained in:
Federico Terzi 2019-09-16 14:25:09 +02:00
parent 899d4da5c4
commit a925af2672

View File

@ -2,6 +2,10 @@
> Cross-platform Text Expander written in Rust > 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) ![example](images/example.gif)
##### What is a Text Expander? ##### What is a Text Expander?
@ -25,13 +29,29 @@ This is useful in many ways:
* **App-specific** configurations * **App-specific** configurations
* File based configuration * File based configuration
## Table of contents
- [Installation](#installation)
- [Windows](#install-windows)
- [Linux](#install-linux)
- [macOS](#install-macos)
- [FAQ](#faq)
- [Donations](#donations)
- [License](#license)
## Installation
### <a name="install-windows"></a>Windows
### <a name="install-linux"></a>Linux
### <a name="install-macos"></a>MacOS
## FAQ
## Getting started
### Installation ## Donations
### Donations
espanso is a free, open source software developed in my (little) spare time. 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, If you liked the project and would like to support further development,
@ -39,7 +59,7 @@ 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) [![Donate with PayPal](images/donate.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=FHNLR5DRS267E&source=url)
### License ## License
espanso was created by [Federico Terzi](http://federicoterzi.com) espanso was created by [Federico Terzi](http://federicoterzi.com)
and is licensed under the [GPL-3.0 license](/LICENSE). and is licensed under the [GPL-3.0 license](/LICENSE).