From 5047e7d130ac1b683baf2ea6176d15205358f83a Mon Sep 17 00:00:00 2001 From: Chris Caron Date: Sat, 16 Dec 2023 15:14:52 -0500 Subject: [PATCH] Updated CLI_Usage (markdown) --- CLI_Usage.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/CLI_Usage.md b/CLI_Usage.md index 4bedc80..1863271 100644 --- a/CLI_Usage.md +++ b/CLI_Usage.md @@ -273,6 +273,30 @@ There is more, but I want to keep my message short. :) _EOF ``` +## Emoji Support +Apprise now offers you the ability to pass in entries like `:slightly_smiling_face:` to have it automatically change this into a :slightly_smiling_face: unicode equivalent. Apprise is loaded with all of the emojis (and their mappings) as defined [here](https://github.com/ikatyang/emoji-cheat-sheet) + +There are 2 ways to orchestrate the emoji engine and begin your translations: +- **Globally** (impact all Apprise endpoints added): + ```bash + # By default assume ?emojis=yes on all URLs + # IF a URL is detected as having ?emojis=no, the no will trump and + # no emoji mapping will be applied + apprise --title=":+1: Great work everyone!" \ + --body="So proud of you all! :rocket:." \ + --interpret-emojis \ + "myschema://credentials" + ``` +- **Per-Instance Basis**: + ```bash + # No use of the --interpret-emojis (-j) flag, however explicit + # reference on the URL we're notifying. + apprise --title=":+1: Great work everyone!" \ + --body="So proud of you all! :rocket:." \ + "myschema://credentials?emojis=yes" + ``` +Emojis offer a more rich use of Apprise. + ## :star2: Tricks and Additional Notes ### Tmux Alert Bell Integration Users of Tmux can link their `alert-bell` to use Apprise like so: