Skip to content

Commit f677ac3

Browse files
committed
Updated documentation
1 parent b3a6b6e commit f677ac3

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,10 @@ This library is a plugin for [Cofoundry](https://www.cofoundry.org/). For more i
99

1010
## Overview
1111

12-
Unfinished
12+
This plugin allows you to send mail using the [SendGrid](https://sendgrid.com/) api. By referencing this package your Cofoundry project will automatically replace the default IMailDispatchService implementation with one that uses SendGrid. Use the following settings to configure the service:
1313

14+
- ***Cofoundry:Plugins:SendGrid:ApiKey*** The api key use when authenticating with the SendGrid api.
15+
- ***Cofoundry:Plugins:SendGrid:Disabled*** Indicates whether the plugin should be disabled, which means services will not be bootstrapped. Defaults to false.
1416

1517

1618

0 commit comments

Comments
 (0)