Skip to content

Commit 1be68a8

Browse files
authored
Merge pull request #30 from circa10a/docs-updates
Docs updates
2 parents 1ae0d6b + 1374e04 commit 1be68a8

File tree

4 files changed

+19
-0
lines changed

4 files changed

+19
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ News). See the [install options](#install-options) for examples on how to instal
4343
Currently supported providers:
4444

4545
- [Discord](providers/discord/README.md)
46+
- [Rocket.Chat](providers/rocketchat/README.md)
47+
- [SMTP (email)](providers/smtp/README.md)
4648
- [Yammer](providers/yammer/README.md)
4749

4850
### Install Options

providers/discord/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,7 @@ providers:
2222
```
2323
2424
[webhooks]:https://support.discordapp.com/hc/en-us/articles/228383668-Intro-to-Webhooks
25+
26+
__Example post:__
27+
28+
![Discord post example](https://i.imgur.com/mzXYTwW.png)

providers/rocketchat/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,7 @@ providers:
2828
```
2929
3030
[webhook]:https://rocket.chat/docs/administrator-guides/integrations/
31+
32+
__Example post:__
33+
34+
![Rocketchat post example](https://i.imgur.com/4bKSTcf.png)

providers/smtp/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,15 @@
2626
# customTemplate: /path/to/email.html
2727
```
2828

29+
## Default Template
30+
31+
The default email template looks like this:
32+
33+
![AWS News default email template](https://i.imgur.com/v6Ec7iK.png)
34+
35+
The footer can be customized in the [config.yaml](/config.yaml) `providers.smtp.footer`. For more
36+
customization see [custom template](#custom-template).
37+
2938
## Custom Template
3039

3140
To provide a custom email html template, start with the `defaultTemplate` included in the code

0 commit comments

Comments
 (0)