Skip to content

Commit 1bfd1b3

Browse files
committed
Added changelog and update readme
1 parent a4b3108 commit 1bfd1b3

File tree

2 files changed

+71
-5
lines changed

2 files changed

+71
-5
lines changed

CHANGELOG.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
5+
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
6+
7+
## 3.0.0 - 2017-12-22
8+
### Added
9+
- Support for a custom sender per e-mail.
10+
11+
### Upgrade from 2.x to 3.x
12+
13+
3.0.0 added support for a custom sender per e-mail. To update please run the following command:
14+
15+
```bash
16+
php artisan migrate
17+
```
18+
19+
## 2.0.0 - 2017-12-14
20+
### Added
21+
- Support for multiple recipients, cc and bcc addresses.
22+
- Support for mailables (*)
23+
- Support for attachments
24+
- New method `later`
25+
26+
*= Only works for Laravel versions 5.5 and up because 5.5 finally introduced a method to read the mailable body.
27+
28+
### Fixed
29+
- Bug causing failed e-mails not to be resent
30+
31+
### Upgrade from 1.x to 2.x
32+
Because 2.0.0 introduced support for attachments, the database needs to be updated. Simply run the following two commands after updating your dependencies and running composer update:
33+
34+
```bash
35+
php artisan migrate
36+
```
37+
38+
## 1.1.3 - 2017-12-07
39+
### Fixed
40+
- Created a small backwards compatibility fix for Laravel versions 5.4 and below.
41+
42+
## 1.1.2 - 2017-11-18
43+
### Fixed
44+
- Incorrect auto discovery namespace for Laravel 5.5
45+
46+
47+
## 1.1.1 - 2017-08-02
48+
### Changed
49+
- Only dispatch `before.send` event during unit tests
50+
51+
## 1.1.0 - 2017-07-01
52+
### Added
53+
- PHPUnit tests
54+
- Support for CC and BCC
55+
56+
## 1.0.0 - 2017-06-29
57+
### Added
58+
59+
- Initial release of the package

README.md

+12-5
Original file line numberDiff line numberDiff line change
@@ -89,22 +89,29 @@ You may also pass a mailable to the e-mail composer.
8989

9090
```php
9191
Email::compose()
92-
->mailable(new OrderShipped())
93-
->send();
92+
->mailable(new OrderShipped())
93+
->send();
9494
```
9595

9696
### Attachments
9797

9898
```php
9999
Email::compose()
100-
->attach('/path/to/file');
100+
->attach('/path/to/file');
101101
```
102102

103103
Or for in-memory attachments...
104104

105105
```php
106106
Email::compose()
107-
->attachData('<p>Your order has shipped!</p>', 'order.html');
107+
->attachData('<p>Your order has shipped!</p>', 'order.html');
108+
```
109+
110+
### Custom Sender
111+
112+
```php
113+
Email::compose()
114+
->from('[email protected]', 'John Doe');
108115
```
109116

110117
### Schedule An Email
@@ -113,7 +120,7 @@ You may schedule an e-mail by calling `later` instead of `send` at the end of th
113120

114121
```php
115122
Email::compose()
116-
->later('+2 hours');
123+
->later('+2 hours');
117124
```
118125

119126
### Manually Sending E-mails

0 commit comments

Comments
 (0)