Skip to content

Commit 73ffde0

Browse files
Updated Readme
1 parent 16cf946 commit 73ffde0

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
![](https://img.shields.io/nuget/v/icg.netcore.utilities.email.resend.svg) ![](https://img.shields.io/nuget/dt/icg.netcore.utilities.email.resend.svg)
66

7-
This library provides an easy to use implementation of Resend based email delivery. This abstraction with proper interfaces allows email implementation inside of your project with little effort and easy to manage integration, and boasts features such as automatic environment name appending as well as robust email templates.
7+
This library provides an easy-to-use implementation of Resend-based email delivery. This abstraction with proper interfaces allows email implementation inside of your project with little effort and easy-to-manage integration, and boasts features such as automatic environment name appending as well as robust email templates.
88

99
This package depends on the ICG.NetCore.Utilities.Email project for template implementation
1010

@@ -14,6 +14,9 @@ The following additional NuGet packages are installed with this extension.
1414
* [Resend](https://www.nuget.org/packages/resend/) - For email delivery
1515
* [ICG NET Core Utilities Email](https://github.com/IowaComputerGurus/netcore.utilities.email) - For Email Template Configuration
1616

17+
### Resend Account
18+
You must have a [Resend Account](https://www.resend.com) and an API key value to utilize this service.
19+
1720
## Usage
1821

1922
### Installation
@@ -28,14 +31,13 @@ To setup the needed dependency injection items for this library, add the followi
2831
services.UseIcgNetCoreUtilitiesEmailResend();
2932
```
3033

31-
Additionally you must specify the needed configuration elements within your AppSettings.json file
34+
Additionally, you must specify the needed configuration elements within your AppSettings.json file
3235

3336
``` json
3437
"ResendServiceOptions": {
3538
"AdminEmail": "test@test.com",
3639
"AdminName": "John Smith",
3740
"ResendApiKey": "YourKey",
38-
"AdditionalApiKeys": { "SpecialSender": "SpecialKey" },
3941
"AlwaysTemplateEmails": true,
4042
"AddEnvironmentSuffix": true
4143
},
@@ -51,7 +53,6 @@ Additionally you must specify the needed configuration elements within your AppS
5153
| AdminEmail | This is the email address used as the "from" address and also for any usage of the "SendToAdministrator" option |
5254
| AdminName | If specified this is the name that will be used for the "From" address on all outbound emails |
5355
| ResendApiKey | The API Key to use for default sending of email addresses |
54-
| AdditionalApiKeys | These are name/value pairs of additional API keys that could be used for sending emails. Totally optional |
5556
| AlwaysTemplateEmails | If selected ALL emails sent will be templated, by default using the "DefaultTemplate" as configured |
5657
| AddEnvironmentSuffix | If selected, all outbound emails sent from non-production addresses will have the environment name added to the end of the subject |
5758
| DefaultTemplatePath | The path, relative to the application root, where the default HTML template can be found for emails |
@@ -60,7 +61,7 @@ Additionally you must specify the needed configuration elements within your AppS
6061

6162
### Usage
6263

63-
Usage is primarly completed by injecting the IEmailService interface to your respective project, one injected emails can be sent with a single line of code.
64+
Usage is primarily completed by injecting the IEmailService interface into your respective project, and one injected email can be sent with a single line of code.
6465

6566
``` csharp
6667
_ResendService.SendEmail("recipient@me.com", "My Subject", "<p>Hello!</p>");

0 commit comments

Comments
 (0)