Skip to content

Commit 5fa6593

Browse files
committed
update readme
1 parent 9912271 commit 5fa6593

File tree

3 files changed

+49
-11
lines changed

3 files changed

+49
-11
lines changed

composer.json

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
{
22
"name": "jeremykenedy/laravel-exception-notifier",
33
"description": "Laravel exception notifier will send an email of of the error along with the stack trace to the chosen recipients.",
4-
"keywords": ["laravel", "exception", "notification", "email"],
4+
"keywords": [
5+
"laravel",
6+
"exception",
7+
"notification",
8+
"email"
9+
],
510
"license": "MIT",
611
"type": "package",
712
"authors": [
@@ -28,4 +33,4 @@
2833
"config": {
2934
"sort-packages": true
3035
}
31-
}
36+
}

readme.md

Lines changed: 40 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,26 @@
22

33
[![Total Downloads](https://poser.pugx.org/jeremykenedy/laravel-exception-notifier/d/total.svg)](https://packagist.org/packages/jeremykenedy/laravel-exception-notifier)
44
[![Latest Stable Version](https://poser.pugx.org/jeremykenedy/laravel-exception-notifier/v/stable.svg)](https://packagist.org/packages/jeremykenedy/laravel-exception-notifier)
5+
[![StyleCI](https://github.styleci.io/repos/91833181/shield?branch=master)](https://github.styleci.io/repos/91833181)
56
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
67

7-
## Introduction
8-
Laravel exception notifier will send an email of the error along with the stack trace to the chosen recipients. [This Package](https://packagist.org/packages/jeremykenedy/laravel-exception-notifier) includes all necessary traits, views, configs, and Mailers for email notifications upon your applications exceptions. You can customize who send to, cc to, bcc to, enable/disable, and custom subject or default subject based on environment. Built for Laravel 5.2, 5.3, 5.4, 5.5+.
8+
Table of contents:
9+
- [About](#about)
10+
- [Requirements](#requirements)
11+
- [Installation Instructions](#installation-instructions)
12+
- [Screenshots](#screenshots)
13+
- [File Tree](#file-tree)
14+
- [License](#license)
15+
16+
## About
17+
Laravel exception notifier will send an email of the error along with the stack trace to the chosen recipients. [This Package](https://packagist.org/packages/jeremykenedy/laravel-exception-notifier) includes all necessary traits, views, configs, and Mailers for email notifications upon your applications exceptions. You can customize who send to, cc to, bcc to, enable/disable, and custom subject or default subject based on environment. Built for Laravel 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, and 5.8+.
918

1019
Get the errors and fix them before the client even reports them, that's why this exists!
1120

1221
## Requirements
13-
* [Laravel 5.2, 5.3, 5.4, or 5.5+](https://laravel.com/docs/installation)
22+
* [Laravel 5.2, 5.3, 5.4, 5.5, 5.6, 5.7, 5.8+](https://laravel.com/docs/installation)
1423

15-
## Installation
24+
## Installation Instructions
1625
1. From your projects root folder in terminal run:
1726

1827
```
@@ -109,17 +118,41 @@ Register the package with laravel in `config/app.php` under `providers` with the
109118
110119
```
111120
EMAIL_EXCEPTION_ENABLED=false
112-
EMAIL_EXCEPTION_FROM=email@email.com
121+
EMAIL_EXCEPTION_FROM='email@email.com'
113122
EMAIL_EXCEPTION_TO='email1@gmail.com, email2@gmail.com'
114123
EMAIL_EXCEPTION_CC=''
115124
EMAIL_EXCEPTION_BCC=''
116125
EMAIL_EXCEPTION_SUBJECT=''
117126
```
118127
119128
## Screenshots
120-
121129
![Email Notification](https://s3-us-west-2.amazonaws.com/github-project-images/laravel-exception-notifier/exception-error-email-min.jpeg)
122130
123-
## License
131+
## File Tree
132+
```
133+
└── laravel-exception-notifier
134+
├── .gitignore
135+
├── LICENSE
136+
├── composer.json
137+
├── readme.md
138+
└── src
139+
├── .env.example
140+
├── App
141+
│   ├── Mail
142+
│   │   └── ExceptionOccured.php
143+
│   └── Traits
144+
│   └── ExceptionNotificationHandlerTrait.php
145+
├── LaravelExceptionNotifier.php
146+
├── config
147+
│   └── exceptions.php
148+
└── resources
149+
└── views
150+
└── emails
151+
└── exception.blade.php
152+
```
153+
154+
* Tree command can be installed using brew: `brew install tree`
155+
* File tree generated using command `tree -a -I '.git|node_modules|vendor|storage|tests'`
124156
157+
## License
125158
Laravel-Exception-Notifier | A Laravel Exceptions Email Notification Package is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)

src/.env.example

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ PUSHER_APP_SECRET=
3434

3535
# Email Expection Settings are optional as defaults are set in config/exceptions.php - below are example values
3636
EMAIL_EXCEPTION_ENABLED=false
37-
EMAIL_EXCEPTION_FROM=jeremykenedy@gmail.com
37+
EMAIL_EXCEPTION_FROM='jeremykenedy@gmail.com'
3838
EMAIL_EXCEPTION_TO='jeremyekenedy@gmail.com,jeremykenedy@gmail.com'
3939
EMAIL_EXCEPTION_CC=''
4040
EMAIL_EXCEPTION_BCC=''
41-
EMAIL_EXCEPTION_SUBJECT=''
41+
EMAIL_EXCEPTION_SUBJECT=''

0 commit comments

Comments
 (0)