Skip to content

Commit 83ea0e4

Browse files
authored
Create README.md
1 parent f086f73 commit 83ea0e4

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# cherry-logger
2+
The Cherry-project logger
3+
4+
[![GitHub license](https://img.shields.io/github/license/abgeo07/cherry-logger.svg)](https://github.com/ABGEO07/cherry-logger/blob/master/LICENSE)
5+
6+
[![GitHub release](https://img.shields.io/github/release/abgeo07/cherry-logger.svg)](https://github.com/ABGEO07/cherry-logger/releases)
7+
8+
------------
9+
10+
## Including
11+
Install from composer `composer require cherry-project/logger`
12+
13+
Include Autoloader in your main file (Ex.: index.php)
14+
```php
15+
require_once __DIR__ . '/vendor/autoload.php';
16+
```
17+
Import class
18+
```php
19+
use Cherry\Logger;
20+
```
21+
Set logs directory
22+
```php
23+
define('LOGS_DIR', __DIR__ . '/var/log');
24+
```
25+
Crete class new object
26+
```php
27+
$logger = new Logger(LOGS_DIR);
28+
```
29+
30+
## Logger methods
31+
The logger has 3 methods (Log types): info, warning, error;
32+
33+
### Call methods
34+
```php
35+
$logger->info('Info Message');
36+
$logger->warning('Warning Message');
37+
$logger->error('Error Message');
38+
```
39+
40+
**2019 &copy; Temuri Takalandze <[email protected]>**

0 commit comments

Comments
 (0)