Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
hegdenischay committed Jun 26, 2024
1 parent a418a42 commit aa913a9
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 href="https://matrix.to/#/#nio-template:matrix.org"><img src="https://img.shields.io/matrix/nio-template:matrix.org?color=blue&label=Join%20the%20Matrix%20Room&server_fqdn=matrix-client.matrix.org" /></a>

A template for creating bots with
Expand Down

0 comments on commit aa913a9

Please sign in to comment.