Skip to content

Commit 3def306

Browse files
committed
Update docs
1 parent 6c60b0e commit 3def306

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

README.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Tatter\Outbox
22
Email toolkit for CodeIgniter 4
33

4-
[![](https://github.com/tattersoftware/codeigniter4-outbox/workflows/PHPUnit/badge.svg)](https://github.com/tattersoftware/codeigniter4-outbox/actions?query=workflow%3A%22PHPUnit)
5-
[![](https://github.com/tattersoftware/codeigniter4-outbox/workflows/PHPStan/badge.svg)](https://github.com/tattersoftware/codeigniter4-outbox/actions?query=workflow%3A%22PHPStan)
4+
[![](https://github.com/tattersoftware/codeigniter4-outbox/workflows/PHPUnit/badge.svg)](https://github.com/tattersoftware/codeigniter4-outbox/actions/workflows/test.yml)
5+
[![](https://github.com/tattersoftware/codeigniter4-outbox/workflows/PHPStan/badge.svg)](https://github.com/tattersoftware/codeigniter4-outbox/actions/workflows/analyze.yml)
6+
[![](https://github.com/tattersoftware/codeigniter4-outbox/workflows/Deptrac/badge.svg)](https://github.com/tattersoftware/codeigniter4-outbox/actions/workflows/inspect.yml)
67
[![Coverage Status](https://coveralls.io/repos/github/tattersoftware/codeigniter4-outbox/badge.svg?branch=develop)](https://coveralls.io/github/tattersoftware/codeigniter4-outbox?branch=develop)
78

89
## Quick Start
@@ -21,17 +22,32 @@ model(TemplateModel::class)->findByName('Default')
2122
->send();
2223
```
2324

24-
## Description
25+
## Features
2526

26-
**Outbox** supplies a handful of useful tools to supplement the framework's native `Email`
27-
class.
27+
**Outbox** supplies useful tools to supplement the framework's native `Email` class:
28+
logging, style inlining, and templating.
29+
30+
## Installation
31+
32+
Install easily via Composer to take advantage of CodeIgniter 4's autoloading capabilities
33+
and always be up-to-date:
34+
```bash
35+
composer require tatter/outbox
36+
```
37+
38+
Or, install manually by downloading the source files and adding the directory to
39+
**app/Config/Autoload.php**.
2840

2941
## Configuration (optional)
3042

3143
The library's default behavior can be altered by extending its config file. Copy
3244
**examples/Outbox.php** to **app/Config/** and follow the instructions
3345
in the comments. If no config file is found in **app/Config** then the library will use its own.
3446

47+
If you plan to use the Template Routes (see below) you should also want to configure
48+
[Tatter\Layouts](https://github.com/tattersoftware/codeigniter4-layouts) to ensure the
49+
views are displayed properly for your app.
50+
3551
## Usage
3652

3753
### Logging

0 commit comments

Comments
 (0)