Skip to content

Commit

Permalink
πŸ“ Improve the README
Browse files Browse the repository at this point in the history
  • Loading branch information
Log1x committed Jan 4, 2024
1 parent de1f1f8 commit f0415db
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,17 @@ $ composer require roots/acorn-mail

## Getting Started

Start by publishing the Acorn mail config:
Start by publishing Acorn's mail config:

```sh
$ wp acorn mail:config
```

SMTP credentials are configured using the published `mail.php` config file.

## Usage

SMTP credentials are configured using the published `mail.php` config file. In most applications, you will want to configure the following environment variables:
In most applications, you will want to set the following environment variables:

```env
MAIL_HOST=
Expand All @@ -43,7 +45,7 @@ MAIL_FROM_NAME=
Once the credentials are properly configured, you can send a test email using Acorn's CLI:

```sh
$ wp acorn mail:test
$ wp acorn mail:test [--to=]
```

## Bug Reports
Expand Down

0 comments on commit f0415db

Please sign in to comment.