Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chijioke-ibekwe authored Dec 17, 2024
1 parent 912512e commit 4c43f63
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ To use this package, you need the following requirements:
can provide the email template in 2 ways.
- First is by hosting your email template on `sendgrid`. If this is your preferred option, the `templates_source` should be
set as `sendgrid`. NB: For this to work, you need to also provide your credentials for the `sendgrid` provider.
- Second option is by storing your email templates on the file system as .html templates. The `templates_source` in
- Second option is by storing your email templates on the file system as `.html` templates. The `templates_source` in
this case should be set as `filesystem` and the directory of the templates should be provided on the `templates_directory` under `customizations`. (This option is not currently supported for emails, but will be in the near future).
- The `customizations` array allows you to customize your email parameters, optionally your `queue_name` (not
queue connection) for queueing your notifications, and your templates directory.
Expand Down Expand Up @@ -443,9 +443,9 @@ The following exceptions can be thrown by the package for the scenarios outlined
- Dispatching a Raven with a `Scroll` object without a `contextName` or `recipient`.
- Attempting to send an Email Notification using a `NotificationContext` that has no `email_template_id` when your email provider or
template source is `sendgrid`.
- Attempting to send an Email Notification using a `NotificationContext` that has an invalid channel i.e a channel that
- Attempting to send an Email Notification using a `NotificationContext` that has an invalid channel i.e a channel
that isn't one of "EMAIL", "DATABASE", or "SMS".
- Attempting to send an Email Notification using a `NotificationContext` that has no `email_template_filename` when your email
- Attempting to send an Email Notification using a `NotificationContext` that has no `email_template_filename` when your email
provider is `ses` and template source is `filesystem`.
- Attempting to send a Database Notification using a `NotificationContext` that has no `in_app_template_filename`.
- Attempting to send an SMS Notification using a `NotificationContext` that has no `sms_template_filename`.
Expand Down

0 comments on commit 4c43f63

Please sign in to comment.