diff --git a/README.md b/README.md index 3ff6476..10fde85 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ +# Newbies bot + +- Created with matrix-nio and nio-template +- Creates a welcome message when someone new joins +- Connects to WhatsApp using [mautrix/whatsapp](https://github.com/mautrix/whatsapp) +- PRs welcome. +- If you want to see how messages are sent, [here](https://github.com/hegdenischay/bangalore-welcome-bot/blob/master/bangalore_bot/callbacks.py#L82) + +# but wot is a "matrix"? + +- It's a chat protocol, kinda like email (or IRC, if you know that) +- Lets me write one bot and use it in multiple platforms + # Nio Template [![Built with matrix-nio](https://img.shields.io/badge/built%20with-matrix--nio-brightgreen)](https://github.com/poljar/matrix-nio) A template for creating bots with