From a925af2672515203b25f95ded1ff8ee47935e779 Mon Sep 17 00:00:00 2001 From: Federico Terzi Date: Mon, 16 Sep 2019 14:25:09 +0200 Subject: [PATCH] Improve readme --- README.md | 30 +++++++++++++++++++++++++----- 1 file changed, 25 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 160f93e..0a72a2a 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ > 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? @@ -25,13 +29,29 @@ This is useful in many ways: * **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 -## Getting started -### Installation - -### Donations +## 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, @@ -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) -### License +## 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