Skip to content

Commit f5adbc1

Browse files
committed
add README
1 parent 5026d32 commit f5adbc1

1 file changed

Lines changed: 50 additions & 0 deletions

File tree

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Dframe/ActivityLog
2+
3+
[![Latest Stable Version](https://poser.pugx.org/dframe/activitylog/v/stable)](https://packagist.org/packages/dframe/activitylog)
4+
[![Latest Unstable Version](https://poser.pugx.org/dframe/dframe/v/unstable)](https://packagist.org/packages/dframe/activitylog)
5+
[![License](https://poser.pugx.org/dframe/dframe/license)](https://packagist.org/packages/dframe/dframe)
6+
7+
8+
**Documentation available at** [https://dframeframework.com](https://dframeframework.com/en/page/index)
9+
10+
Language
11+
[Polish](https://dframeframework.com/en/page/docs) | [English](https://dframeframework.com/en/page/docs)
12+
13+
### Installation Composer
14+
15+
```sh
16+
$ composer require dframe/activitylog
17+
```
18+
19+
20+
PSR-3 Adapter
21+
```php
22+
use Dframe\ActivityLog\Activity;
23+
use Dframe\ActivityLog\Demo\Drivers\PSR3FileLog;
24+
use Dframe\ActivityLog\Helper\Psr3Adapter;
25+
use Psr\Log\LogLevel;
26+
27+
require_once __DIR__ . '/../../vendor/autoload.php';
28+
29+
$log = new Activity(new PSR3FileLog());
30+
31+
$logger = new Psr3Adapter($log, 'System', \Dframe\ActivityLog\Entity\PSR3::class);
32+
$logger->log(LogLevel::ERROR, 'This is {error}', ['error' => 'error #500']);
33+
```
34+
35+
Standard Usage
36+
37+
```php
38+
use Dframe\ActivityLog\Activity;
39+
use Dframe\ActivityLog\Demo\Drivers\FileLog;
40+
41+
require_once __DIR__ . '/../../vendor/autoload.php';
42+
43+
$log = (new Activity(new FileLog()));
44+
$log->log('Hello Word!')->entity(\Dframe\ActivityLog\Demo\Entity\Action::class'])->push();
45+
```
46+
47+
Display Logs
48+
```php
49+
$log->logs();
50+
```

0 commit comments

Comments
 (0)