From a9f469ecf3ebbd9fa736b34a81eebbb0331b4834 Mon Sep 17 00:00:00 2001 From: Amolith Date: Thu, 3 Jul 2025 14:16:02 -0600 Subject: [PATCH] docs: add examples --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 06c250394f0a48f0691ae52a27e364c704eed107..e08904f3287a38a6d21636bfddd1c8009182ef35 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,22 @@ SPDX-License-Identifier: Unlicense A grumpy old herald who watches your Mumble server and announces comings and goings via XMPP. +## Examples + +**Joining a channel:** + +- ➡️ {USERNAME} stumbles into {CHANNEL} +- ➡️ _grumbles_ Oh, look who's decided to grace {CHANNEL} with their presence... {USERNAME} +- ➡️ _adjusts spectacles_ Hmph! {USERNAME} wanders into {CHANNEL} with purpose unknown +- ➡️ _sighs heavily_ Another soul wanders into {CHANNEL}... {USERNAME}, was it? + +**Leaving a channel:** + +- ⬅️ Oh, what? _ahem_ {USERNAME} fled... somewhere _waves hand_ +- ⬅️ {USERNAME} vanishes into the void... +- ⬅️ _grumbles_ Well, that was brief... {USERNAME} has wandered off to other adventures +- ⬅️ _mutters_ {USERNAME} has departed from us. Just when things were getting interesting... + ## Full setup - Create a herald user with minimal permissions