Skip to content

Commit 5d4b808

Browse files
committed
Update README.md
1 parent 49c68b4 commit 5d4b808

1 file changed

Lines changed: 39 additions & 5 deletions

File tree

README.md

Lines changed: 39 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,45 @@
1-
# Rollbar plugin for CakePHP
1+
# Rollbar plugin for CakePHP 3.x
2+
3+
CakePHP plugin integration for Rollbar error tracking tool.
4+
5+
## Requirements
6+
7+
- CakePHP 3.5 or greater
8+
- PHP 5.6 or greater
9+
- And [Rollbar](https://rollbar.com/) account
210

311
## Installation
412

5-
You can install this plugin into your CakePHP application using [composer](https://getcomposer.org).
13+
1. You can install this plugin into your CakePHP application using [composer](https://getcomposer.org)
614

7-
The recommended way to install composer packages is:
15+
```
16+
composer require ishan-biztech/cake-rollbar
17+
```
818
19+
2. After installation, [load the plugin](https://book.cakephp.org/3/en/plugins.html#loading-a-plugin)
20+
```php
21+
// src/Application.php
22+
Plugin::load('Rollbar');
23+
```
24+
Or, you can load the plugin using the shell command:
25+
```sh
26+
bin/cake plugin load Rollbar
27+
```
28+
29+
## Setup
30+
31+
Create a new Rollbar project and get `post_server_item` access token by going to your project's settings. And set below config array into your `config/app.php` file.
32+
33+
```php
34+
// config/app.php
35+
return [
36+
'Rollbar' => [
37+
'access_token' => env('ROLLBAR_POST_SERVER_ITEM_ACCESS_TOKEN', null),
38+
'environment' => env('APP_ENV'),
39+
]
40+
];
941
```
10-
composer require ishan-biztech/cake-rollbar
11-
```
42+
43+
All set! :tada:
44+
45+
This plugin will capture and send all the notices, errors, exceptions, etc. to Rollbar for you to solve them.

0 commit comments

Comments
 (0)