Skip to content

Commit 51786fc

Browse files
committed
Badges, docs and mkdocs description
Signed-off-by: alexmerlin <alex.merlin.1985@gmail.com>
1 parent 3ac9b7b commit 51786fc

File tree

4 files changed

+28
-6
lines changed

4 files changed

+28
-6
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,22 @@
11
# dot-errorhandler
22

3-
Error Logging Handler for Dotkernel
3+
dot-errorhandler is Dotkernel's PSR-15 compliant error handler.
4+
5+
## Documentation
6+
7+
Documentation is available at: https://docs.dotkernel.org/dot-errorhandler/
8+
9+
## Badges
410

511
![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/dot-errorhandler)
612
![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-errorhandler/4.1.1)
713

814
[![GitHub issues](https://img.shields.io/github/issues/dotkernel/dot-errorhandler)](https://github.com/dotkernel/dot-errorhandler/issues)
915
[![GitHub forks](https://img.shields.io/github/forks/dotkernel/dot-errorhandler)](https://github.com/dotkernel/dot-errorhandler/network)
1016
[![GitHub stars](https://img.shields.io/github/stars/dotkernel/dot-errorhandler)](https://github.com/dotkernel/dot-errorhandler/stargazers)
11-
[![GitHub license](https://img.shields.io/github/license/dotkernel/dot-errorhandler)](https://github.com/dotkernel/dot-errorhandler/blob/4.0/LICENSE)
17+
[![GitHub license](https://img.shields.io/github/license/dotkernel/dot-errorhandler)](https://github.com/dotkernel/dot-errorhandler/blob/4.1/LICENSE)
1218

13-
[![Build Static](https://github.com/dotkernel/dot-errorhandler/actions/workflows/continuous-integration.yml/badge.svg?branch=4.0)](https://github.com/dotkernel/dot-errorhandler/actions/workflows/continuous-integration.yml)
19+
[![Build Static](https://github.com/dotkernel/dot-errorhandler/actions/workflows/continuous-integration.yml/badge.svg?branch=4.1)](https://github.com/dotkernel/dot-errorhandler/actions/workflows/continuous-integration.yml)
1420
[![codecov](https://codecov.io/gh/dotkernel/dot-errorhandler/branch/4.0/graph/badge.svg?token=0KIJARS5RS)](https://codecov.io/gh/dotkernel/dot-errorhandler)
1521

1622
## Adding the error handler

composer.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@
5757
"cs-check": "phpcs",
5858
"cs-fix": "phpcbf",
5959
"test": "phpunit --colors=always",
60-
"test-coverage": "phpunit --colors=always --coverage-clover clover.xml",
6160
"static-analysis": "psalm --shepherd --stats"
6261
}
6362
}

docs/book/v4/overview.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,23 @@
11
# Overview
22

3-
`dot-errorhandler` is Dotkernel's logging error handler, providing two options:
3+
dot-errorhandler is Dotkernel's PSR-15 compliant error handler.
4+
5+
## Badges
6+
7+
![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/dot-errorhandler)
8+
![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-errorhandler/4.1.1)
9+
10+
[![GitHub issues](https://img.shields.io/github/issues/dotkernel/dot-errorhandler)](https://github.com/dotkernel/dot-errorhandler/issues)
11+
[![GitHub forks](https://img.shields.io/github/forks/dotkernel/dot-errorhandler)](https://github.com/dotkernel/dot-errorhandler/network)
12+
[![GitHub stars](https://img.shields.io/github/stars/dotkernel/dot-errorhandler)](https://github.com/dotkernel/dot-errorhandler/stargazers)
13+
[![GitHub license](https://img.shields.io/github/license/dotkernel/dot-errorhandler)](https://github.com/dotkernel/dot-errorhandler/blob/4.1/LICENSE)
14+
15+
[![Build Static](https://github.com/dotkernel/dot-errorhandler/actions/workflows/continuous-integration.yml/badge.svg?branch=4.1)](https://github.com/dotkernel/dot-errorhandler/actions/workflows/continuous-integration.yml)
16+
[![codecov](https://codecov.io/gh/dotkernel/dot-errorhandler/branch/4.0/graph/badge.svg?token=0KIJARS5RS)](https://codecov.io/gh/dotkernel/dot-errorhandler)
17+
18+
## Features
19+
20+
This package provides two features:
421

522
- `Dot\ErrorHandler\ErrorHandler`, same as the Zend Expressive error handling class with the only difference being the removal of the `final` statement for making extension possible
623
- `Dot\ErrorHandler\LogErrorHandler` adds logging support to the default `ErrorHandler` class

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ nav:
2626
- Installation: v3/installation.md
2727
- Configuration: v3/configuration.md
2828
site_name: dot-errorhandler
29-
site_description: "Dotkernel's error logging handler"
29+
site_description: "Dotkernel's PSR-15 compliant error handler"
3030
repo_url: "https://github.com/dotkernel/dot-errorhandler"
3131
plugins:
3232
- search

0 commit comments

Comments
 (0)