Add basic usage documentation
This commit is contained in:
parent
059d350e9e
commit
88eb9ad44d
2 changed files with 6 additions and 3 deletions
|
@ -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
|
||||
|
||||
|
|
7
mostr.py
7
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')
|
||||
|
|
Loading…
Add table
Reference in a new issue