Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hoodie committed Sep 25, 2022
1 parent 814c3b5 commit 41130b0
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 13 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

46 changes: 34 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,45 @@
<div align="center">

# 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/)

</div>

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 <hendrik@hoodie.de>
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 <SUBCOMMAND>
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).

0 comments on commit 41130b0

Please sign in to comment.