diff --git a/README.md b/README.md index f3cb09b..4cee841 100644 --- a/README.md +++ b/README.md @@ -15,13 +15,16 @@ from xbotlib import Bot class EchoBot(Bot): def react(self, msg): - self.reply(f"echo: {msg}") + self.reply(to=message.sender, body=message.body) MyBot() ``` And then `python echo.py`. -## API +## More Examples -TODO. +- **[EchoBot](./examples/echo.py)**: Sends back what you sent it +- **[WhisperBot](./examples/whisper.py)**: Pseudo-anonymous whispering in group chats + +See the [examples](./examples/) directoy for all listings. diff --git a/examples/echo.py b/examples/echo.py index ea7965a..7ecb052 100644 --- a/examples/echo.py +++ b/examples/echo.py @@ -2,10 +2,9 @@ from xbotlib import Bot class EchoBot(Bot): - """SYN/ACK bot for testing things work. + """Gives back what you sent it. - Just direct message the bot and see if you get back what you sent. If so, - then you know your setup is working. + Just direct message the bot and see if you get back what you sent. """