diff --git a/README.md b/README.md index 2487a86..aec620c 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,58 @@ -
+ tiramisu
+ desktop notifications, the UNIX way
+
+ Crafted with ♡ +
-- [polytiramisu by anufrievroman](https://github.com/anufrievroman/polytiramisu) +- [anufrievroman/polytiramisu](https://github.com/anufrievroman/polytiramisu) -# installation +--- -### by package manager ++ Installation +
-Nix users can install `nixos.tiramisu` +|Distribution|Repository|Package name| +|-|-|-| +|Arch Linux|AUR|`tiramisu-git`| +|Alpine Linux|Edge|`tiramisu`| +|NixOS|stable|`nixos.tiramisu`| -Arch users with an AUR package manager can install `tiramisu-git` +Don't see your distribution? Check to make sure it wasn't forgotten at [repology](https://repology.org/projects/?search=tiramisu). +Alternatively, build from source. -### from source - -Clone the repository and build the project. Then move tiramisu to a location that is specified in `$PATH`. - -``` +```sh $ git clone https://github.com/Sweets/tiramisu $ cd ./tiramisu -$ make -# make install +$ make && make install ``` -#### Note that the use of a pound symbol (#) denotes escalated privileges. -#### On most Linux systems this can be done with the usage of `sudo` +--- -# usage ++ Usage +
-tiramisu accepts a single parameter, that being `-o`, which allows users to specify an output format. -The output format specified is interpolated by tiramisu. Listed below are values that are interpolated before output. +By default, tiramisu outputs all information from a notification to standard output. You can change this with `-o`, or if you wish to use JSON format, `-j`. If you need the output format to be sanitized (quotes to be escaped), you can do so with `-s`. -The values are listed by their appearance in the default output format. +Using `-o` will interpolate your desired format. -`#source`, `#icon`, `#id`, `#summary`, `#body`, `#actions`, `#hints`, `#timeout` +Appropriate keys are `#source`, `#icon`, `#id`, `#summary`, `#body`, `#actions`, `#hints`, and `#timeout`. -#### Note that to use linebreaks you will need to actually have a linebreak in the output string. -#### tiramisu will not collapse \X to the appropriate sequence. +Using `-j` implies `-s`. -### Example of default output - -``` -$ tiramisu -``` +Below is an example of the default output of tiramisu with no flags. ``` evolution-mail-notification @@ -66,5 +64,3 @@ desktop-entry=org.gnome.Evolution|urgency=1 Show INBOX=default -1 ``` - -#### Note that only a single process can claim the org.freedesktop.Notifications name at a given time, so any other running notification daemon must be killed before running tiramisu.