diff --git a/README.md b/README.md index fd0c552..a2e4f9b 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,23 @@ -Gotify-SMTP +Gotify-MQTT =========== -A plugin for piping email messages into [Gotify](https://gotify.net/) without ever hitting an email service. Inspiration for this comes from MailHog and similar implementations where there is no backing email service, it simply forwards/receives messages as needed. - -There are other versions of this (specifically using the API), however this is a standalone plugin that can be loaded by Gotify. +A plugin for using [Gotify](https://gotify.net/) to ingest messages from MQTT. Usage ----- Download the plugin from the releases page, or build it from source (using the Makefile). -Point your application settings at GOTIFY_IP port 1025, with the username being the name of the account you'd like to send messages to. +Configure the settings and add your MQTT Brokers. + +Example config: -Limitations ------------ +```yaml +servers: +- address: 127.0.0.1:1883 + username: "" + password: "" + subscribe: + - 'gotify/mqtt' -Currently, HTML messages aren't supported. Markdown might be possible, but currently not planned as most if not all messages include a text/plain variation. \ No newline at end of file +```