Skip to content

Commit

Permalink
Small fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
fpseverino committed Oct 5, 2024
1 parent 9f6f453 commit e03a45b
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 4 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,10 @@ and add it to your target's dependencies:

## Overview

> [!NOTE]
> [!WARNING]
> Make sure that the `SENDGRID_API_KEY` variable is set in your environment.
This can be set in the Xcode scheme, or specified in your `docker-compose.yml`, or even provided as part of a `swift run` command.
A missing API key will result in a fatal error.

### Using the API

Expand Down
4 changes: 2 additions & 2 deletions Sources/SendGrid/Application+SendGrid.swift
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ import SendGridKit
import Vapor

extension Application {
public var sendgrid: Sendgrid {
public var sendgrid: SendGrid {
.init(application: self)
}

public struct Sendgrid: Sendable {
public struct SendGrid: Sendable {
private final class Storage: Sendable {
private struct SendableBox: Sendable {
var client: SendGridClient
Expand Down
2 changes: 1 addition & 1 deletion Sources/SendGrid/Request+SendGrid.swift
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import SendGridKit
import Vapor

extension Request {
public var sendgrid: Application.Sendgrid {
public var sendgrid: Application.SendGrid {
.init(application: self.application)
}
}
4 changes: 4 additions & 0 deletions Sources/SendGrid/SendGrid.docc/SendGrid.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@

Send simple emails, or leverage the full capabilities of SendGrid's V3 API.

> Warning: Make sure that the `SENDGRID_API_KEY` variable is set in your environment.
This can be set in the Xcode scheme, or specified in your `docker-compose.yml`, or even provided as part of a `swift run` command.
A missing API key will result in a fatal error.

### Using the API

You can use all of the available parameters here to build your `SendGridEmail`.
Expand Down

0 comments on commit e03a45b

Please sign in to comment.