Skip to content

Commit 6e82429

Browse files
docs: provide usage docs
1 parent eda55c0 commit 6e82429

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
[![Total Downloads](https://img.shields.io/packagist/dt/esign/laravel-test-mail.svg?style=flat-square)](https://packagist.org/packages/esign/laravel-test-mail)
55
![GitHub Actions](https://github.com/esign/laravel-test-mail/actions/workflows/main.yml/badge.svg)
66

7-
A short intro about the package.
7+
This package provides a simple command to send test emails, allowing you to verify your mail setup in a Laravel application.
8+
It supports both immediate sending and queueing of test emails.
89

910
## Installation
1011

@@ -14,14 +15,22 @@ You can install the package via composer:
1415
composer require esign/laravel-test-mail
1516
```
1617

17-
The package will automatically register a service provider.
18+
## Usage
19+
20+
### Sending a Test Mail
21+
You can use the `mail:test` command to send a test mail to a specified recipient:
1822

19-
Next up, you can publish the configuration file:
2023
```bash
21-
php artisan vendor:publish --provider="Esign\TestMail\TestMailServiceProvider" --tag="config"
24+
php artisan mail:test [email protected]
2225
```
2326

24-
## Usage
27+
### Queueing a Test Mail
28+
29+
If you want to queue the test mail instead of sending it immediately, you can use the `--queue` option:
30+
31+
```bash
32+
php artisan mail:test [email protected] --queue
33+
```
2534

2635
### Testing
2736

0 commit comments

Comments
 (0)