From 88eb9ad44d3c14ff1e71d55bc93d05fd5306a60c Mon Sep 17 00:00:00 2001 From: xeruf <27jf@pm.me> Date: Sat, 7 Dec 2024 00:23:03 +0100 Subject: [PATCH] Add basic usage documentation --- README.md | 2 +- mostr.py | 7 +++++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bfcb71ed..4cd4fad6 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -This is a zulip bot to create mostr tasks on a nostr relay. +A Zulip bot to create [mostr](https://forge.ftt.gmbh/janek/mostr) tasks on a nostr relay. # Quickstart diff --git a/mostr.py b/mostr.py index d6f4c8bd..26004b6f 100644 --- a/mostr.py +++ b/mostr.py @@ -20,10 +20,13 @@ def parse_pubkey(key_str: str) -> PublicKey: class MostrHandler: - """A Zulip bot for Mostr""" + """A Zulip bot to create mostr tasks on a nostr relay.""" def usage(self) -> str: - return "Send me a message to create a task!" + return """ + Send me a message to create a task! + Use '#' and '-' to add resp. remove tags from the current context. + """ def initialize(self, bot_handler: AbstractBotHandler) -> None: self.config_info = bot_handler.get_config_info('mostr')