From 41130b012b5b75e8cea906ba7062244581174b21 Mon Sep 17 00:00:00 2001 From: Hendrik Sollich Date: Sun, 25 Sep 2022 14:31:58 +0200 Subject: [PATCH] docs: update readme --- Cargo.lock | 2 +- README.md | 46 ++++++++++++++++++++++++++++++++++------------ 2 files changed, 35 insertions(+), 13 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 326f817..db9111c 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1326,7 +1326,7 @@ dependencies = [ [[package]] name = "toastify" -version = "0.5.0" +version = "0.5.1" dependencies = [ "clap", "notify-rust", diff --git a/README.md b/README.md index c370909..99e203a 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,45 @@ +
+ # toastify +[![build](https://img.shields.io/github/workflow/status/hoodie/toastify/Continuous%20Integration)](https://github.com/hoodie/toastify/actions?query=workflow%3A"Continuous+Integration") +[![Crates.io](https://img.shields.io/crates/d/toastify)](https://crates.io/crates/toastify) +[![contributors](https://img.shields.io/github/contributors/hoodie/toastify)](https://github.com/hoodie/toastify/graphs/contributors) +![maintenance](https://img.shields.io/maintenance/yes/2023) + +[![version](https://img.shields.io/crates/v/toastify)](https://crates.io/crates/toastify/) +[![license](https://img.shields.io/crates/l/toastify.svg?style=flat)](https://crates.io/crates/toastify/) + +
+ A commandline tool that shows desktop notifications using [notify-rust](https://docs.rs/notify-rust/). -``` -toastify 0.5.0 + +```text +toastify 0.5.1 Hendrik Sollich -sending desktop notifications since 2015 +A commandline tool that shows desktop notifications using +[notify-rust](https://docs.rs/notify-rust/). USAGE: - toastify [FLAGS] [SUBCOMMAND] + toastify -FLAGS: - -h, --help Prints help information - -V, --version Prints version information +OPTIONS: + -h, --help Print help information + -V, --version Print version information SUBCOMMANDS: - help Prints this message - info Shows information about the running notification server - send Shows a notification - server Starts a little notification server for testing - + help Print this message or the help of the given subcommand(s) + send Shows a notification ``` + +*** + +## Contribution +Any help in form of descriptive and friendly [issues](https://github.com/hoodie/toastify/issues) or comprehensive pull requests are welcome! + + +Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in toastify by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. + +### Conventions +The Changelog of this library is generated from its commit log, there any commit message must conform with https://www.conventionalcommits.org/en/v1.0.0/. For simplicity you could make your commits with [convco](https://crates.io/crates/convco).