~gjabell/mfn

7e71842bda3828122365f29b1c28fcb39dce67c2 — Galen Abell 1 year, 1 month ago 5b42812
Update README
1 files changed, 16 insertions(+), 0 deletions(-)

M README.md
M README.md => README.md +16 -0
@@ 2,6 2,8 @@

Send notifications to various sources when [Miniflux](https://miniflux.app) finds new RSS entries.

Currently supported sources include Email, Gotify, and Webhooks.

## Example Usage

1. Create a TOML configuration file with the following format:


@@ 28,6 30,20 @@ username = "myuser" # email server username
password = "mypass" # email server password
server = "smtp.example.com:587" # email server url with port

[gotify]
title_template = """
New Entry: {{ .Title }}{{ if ne .Author "" }} • {{ .Author }}{{ end }}
""" # golang html/template-compatible template string, which will be sent as the title of the message
message_template = """
{{ if ne .Content "" }}
{{ .Content }}
{{ end }}
URL: {{ .URL }}
""" # golang html/template-compatible template string, which will be sent as the body of the message
server = "https://gotify.example.com" # gotify server url
token = "mytoken" # app authentication token generated by gotify
priority = 10 # optional message priority

[webhook]
template = """
<h3>{{ .Title }}{{ if ne .Author "" }} • <i>{{ .Author }}</i>{{ end }}</h3>