Skip to content

Commit 3107806

Browse files
committed
- README update
1 parent 79833a0 commit 3107806

1 file changed

Lines changed: 10 additions & 13 deletions

File tree

README.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,9 @@ can be set separately and process messages based on the log level.
77

88
[![Latest Stable Version](https://img.shields.io/packagist/v/koded/logging.svg)](https://packagist.org/packages/koded/logging)
99
[![Build Status](https://travis-ci.org/kodedphp/logging.svg?branch=master)](https://travis-ci.org/kodedphp/logging)
10-
[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/81ffd9cf1725485d8f6fb836617d002d)](https://www.codacy.com/app/kodeart/logging)
11-
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/81ffd9cf1725485d8f6fb836617d002d)](https://www.codacy.com/app/kodeart/logging)
10+
[![Code Coverage](https://scrutinizer-ci.com/g/kodedphp/logging/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/kodedphp/logging/?branch=master)
11+
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/kodedphp/logging/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/kodedphp/logging/?branch=master)
1212
[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%207.1-8892BF.svg)](https://php.net/)
13-
[![Software license](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](LICENSE)
1413

1514

1615
Installation
@@ -56,8 +55,6 @@ $log->warning("You don't see anything");
5655
Configuration
5756
-------------
5857

59-
@TODO Fix the text for `register()` and `deferred` flag
60-
6158
| Param | Type | Required | Default | Description |
6259
|-----------:|:------:|:--------:|:----------------|:------------|
6360
| loggers | array | yes | (empty) | An array of log processors. Every processor is defined in array with it's own configuration parameters. See [processor directives](processor-default-directives) |
@@ -99,18 +96,18 @@ Tips:
9996
Processors
10097
----------
10198

102-
| Class name | Description |
103-
|-----------:|:-------------------------------------------------------------------------------------|
104-
| ErrorLog | uses the [error_log()][error-log] function to send the message to PHP's logger |
105-
| SysLog | will open the system logger and send messages using the [syslog()][syslog] function |
106-
| Cli | write the messages in the console (with STDOUT) |
107-
| Memory | will store all messages in an array. Useful for unit tests if the logger is involved |
108-
| File | saves the messages on a disk. **It's a slow one and should be avoided** |
99+
| Class name | Description |
100+
|------------------:|:-------------------------------------------------------------------------------------|
101+
| ErrorLog | uses the [error_log()][error-log] function to send the message to PHP's logger |
102+
| Cli | write the messages in the console (with STDERR) |
103+
| Memory | will store all messages in an array. Useful for unit tests if the logger is involved |
104+
| SysLog **(slow)** | will open the system logger and send messages using the [syslog()][syslog] function |
105+
| File **(slow)** | saves the messages on a disk |
109106

110107

111108
License
112109
-------
113-
110+
[![Software license](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](LICENSE)
114111
The code is distributed under the terms of [The 3-Clause BSD license](LICENSE).
115112

116113
[psr-3]: http://www.php-fig.org/psr/psr-3/

0 commit comments

Comments
 (0)