Skip to content

Commit f57da12

Browse files
committed
Refactored the WP Plugin readme.txt file.
1 parent 063cefa commit f57da12

File tree

2 files changed

+100
-54
lines changed

2 files changed

+100
-54
lines changed

assets/screenshot-1.png

109 KB
Loading

readme.txt

Lines changed: 100 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,34 @@
11
=== Rollbar ===
2-
Contributors: arturmoczulski, jorbin
2+
Contributors: arturmoczulski, jorbin, danielmorell
33
Tags: rollbar, full stack, error, tracking, error tracking, error reporting, reporting, debug
4-
Requires at least: 4.4.0
5-
Tested up to: 6.3.1
6-
Stable tag: 2.7.1
4+
Requires at least: 6.5.0
5+
Tested up to: 6.8
6+
Requires PHP: 8.1
7+
Stable tag: 3.0.0
78
License: GPLv2 or later
89
License URI: http://www.gnu.org/licenses/gpl-2.0.html
910

1011
Official Rollbar full-stack error tracking for WordPress supported by Rollbar, Inc.
1112

1213
== Description ==
13-
Rollbar collects errors that happen in your application, notifies you, and analyzes them so you can debug and fix them.
1414

15+
Rollbar collects errors that happen in your application, notifies you, and analyzes them so you can debug and fix them.
1516
This plugin integrates Rollbar into your WordPress installation.
1617

17-
Find out [how Rollbar can help you decrease development and maintenance costs](https://rollbar.com/features/).
18-
19-
See [real companies improving their development workflow thanks to Rollbar](https://rollbar.com/customers/).
20-
2118
= Features =
2219

23-
* PHP & Javascript error logging
24-
* Define an environment for each single WordPress installation or Multisite blog
25-
* Specify your desired logging level
20+
* PHP & JavaScript error logging.
21+
* Define an environment for each single WordPress installation or Multisite blog.
22+
* Specify your desired logging level.
2623
* Regular updates and improvements!
2724

28-
> <strong>Please note</strong><br>
29-
> In order to use this plugin, a [Rollbar account](https://rollbar.com/) is required.
25+
**Please note:**
26+
In order to use this plugin, a [Rollbar account](https://rollbar.com/) is required.
3027

3128
= Support =
3229

33-
* Browse [issue tracker](https://github.com/rollbar/rollbar-php-wordpress/issues) on GitHub and report new issues
34-
* If you run into any issues, please email us at [[email protected]](mailto:[email protected])
30+
* Browse [issue tracker](https://github.com/rollbar/rollbar-php-wordpress/issues) on GitHub and report new issues.
31+
* If you run into any issues, please email us at [[email protected]](mailto:[email protected]).
3532
* For bug reports, please [open an issue on GitHub](https://github.com/rollbar/rollbar-php-wordpress/issues/new).
3633

3734
= You like it? =
@@ -46,62 +43,110 @@ This plugin is a community-driven contribution. All rights reserved to [Rollbar]
4643

4744
The installation and configuration of the plugin are as simple as it can be.
4845

49-
= Through [WordPress Plugin directory](https://wordpress.org/plugins/rollbar/) =
46+
= Through WordPress Plugin directory =
5047

51-
The easiest way to install the plugin is from the WordPress Plugin directory. If you have an existing WordPress installation and you want to add Rollbar:
48+
The easiest way to install the plugin is from the WordPress Plugin directory. If you have an existing WordPress
49+
installation, and you want to add Rollbar:
5250

5351
1. In your WordPress administration panel go to `Plugins` → `Add New`.
5452
2. Search for "Rollbar" and find `Rollbar` by Rollbar in the search results.
5553
3. Click `Install Now` next to the `Rollbar` plugin.
56-
4. In `Plugins` → `Installed plugins` find `Rollbar` and click `activate` underneath.
57-
5. Log into your [Rollbar account dashboard](https://rollbar.com/login/).
58-
6. Go to `Settings` → `Project Access Tokens`.
59-
7. Copy the token value under `post_client_item` and `post_server_item`.
60-
8. Navigate to `Tools` → `Rollbar`.
61-
9. Enable `PHP error logging` and/or `Javascript error logging` depending on your needs.
62-
10. Paste the tokens you copied in step 7 in `Access Token` section.
63-
11. Provide the name of your environment in `Environment`. By default, the environment will be taken from `WP_ENV` environment variable if it's set otherwise it's blank. We recommend to fill this out either with `development` or `production`.
64-
12. Pick a minimum logging level. Only errors at that or higher level will be reported. For reference: [PHP Manual: Predefined Error Constants](http://php.net/manual/en/errorfunc.constants.php).
65-
13. Click `Save Changes`.
54+
4. In `Plugins` → `Installed plugins` find `Rollbar` and click `Activate` underneath.
55+
56+
**Warning**: This installation method might not be suitable for complex WordPress projects. The plugin installed this
57+
way will be self-contained and include all of the required dependencies for itself and the `rollbar/rollbar-php`
58+
library. In complex projects, this might lead to version conflicts between dependencies and other plugins/packages. If
59+
this is an issue in your project, we recommend the "Packagist" installation method.
6660

67-
**Warning**: This installation method might not be suitable for complex WordPress projects. The plugin installed this way will be self-contained and include all of the required dependencies for itself and `rollbar/rollbar-php` library. In complex projects, this might lead to version conflicts between dependencies and other plugins/packages. If this is an issue in your project, we recommend the "Advanced" installation method. For more information why this might be important for you, read [Using Composer with WordPress]().
61+
= Through Packagist =
6862

69-
= Through [wpackagist](https://wpackagist.org/) (if you manage your project with Composer) *recommended* =
63+
*Note: this only works if your WordPress project is managed with Composer.
64+
Read [Using Composer with WordPress](https://roots.io/using-composer-with-wordpress/) for more details.*
7065

71-
This is a recommended way to install Rollbar plugin for advanced projects. This way ensures the plugin and all of its' dependencies are managed by Composer.
66+
This is a recommended way to install the Rollbar plugin for advanced projects. This way ensures the plugin and all of
67+
its dependencies are managed by Composer.
7268

73-
1. If your WordPress project is not managed with Composer yet, we suggest looking into upgrading your WordPress: [Using Composer with WordPress]().
74-
2. In your `composer.json` add `wpackagist-plugin/rollbar` to your `require` section, i.e.:
69+
You can install the plugin by running the following command in the root directory of your WordPress project:
70+
71+
```txt
72+
composer require rollbar/rollbar-php-wordpress:^3.0
7573
```
76-
"require": {
77-
"php": ">=8.1",
78-
...,
79-
"wpackagist-plugin/rollbar": "*"
80-
}
74+
75+
= Through WPackagist =
76+
77+
*Note: if your WordPress project is managed with Composer, we strongly recommend installing the plugin through
78+
Packagist instead.*
79+
80+
*Installing the plugin from wpackagist.org instead of packagist.org will result in the plugin being managed by
81+
Composer. However, the downside is that it's dependencies will not be managed by composer. Instead they will be packaged
82+
in the plugin's `vendor` directory not in your project's `vendor` directory. This has the potential to cause name
83+
collisions if other plugins or your project use different versions of the same dependencies.*
84+
85+
To install the plugin from wpackagist.org run the following steps command in the root directory of your WordPress
86+
project:
87+
88+
```txt
89+
composer require wpackagist-plugin/rollbar
90+
```
91+
92+
= Configuration =
93+
94+
The plugin can be configured in the WordPress Admin or programmatically.
95+
96+
**WordPress Admin**
97+
98+
The plugin provides a settings page in the WordPress Admin that allows you to configure the plugin. This settings page
99+
can be disabled by setting the `ROLLBAR_DISABLE_ADMIN` constant to `true` in your `wp-config.php` file.
100+
101+
1. In `Plugins` → `Installed plugins` find `Rollbar` and click `Activate` underneath.
102+
2. Log into your [Rollbar account dashboard](https://rollbar.com/login/):
103+
1. Go to `Settings` → `Project Access Tokens`.
104+
2. Copy the token value under `post_client_item` and `post_server_item`.
105+
3. In WordPress, navigate to `Settings` → `Rollbar`:
106+
1. Enable `PHP error logging` and/or `Javascript error logging` depending on your needs.
107+
2. Paste the tokens you copied in step 7 in `Access Token` section.
108+
3. Provide the name of your environment in `Environment`. By default, the environment will be taken from `WP_ENV`
109+
environment variable if it's set otherwise it's blank. We recommend to fill this out either with `development` or
110+
`production`.
111+
4. Pick a minimum logging level. Only errors at that or higher level will be reported. For
112+
reference: [PHP Manual: Predefined Error Constants](http://php.net/manual/en/errorfunc.constants.php).
113+
5. Click `Save Changes`.
114+
115+
**Programmatic Configuration**
116+
117+
The plugin can also be configured programmatically. This is useful if you want to configure the plugin in a more
118+
advanced way or if you want to disable the admin settings page.
119+
120+
```php
121+
// wp-config.php
122+
123+
// Configure the plugin.
124+
define( 'ROLLBAR_SETTINGS', [
125+
'php_logging_enabled' => true,
126+
'server_side_access_token' => '<your token>',
127+
'js_logging_enabled' => true,
128+
'client_side_access_token' => '<your client token>',
129+
'environment' => 'development',
130+
'included_errno' => E_ERROR,
131+
'enable_person_reporting' => true,
132+
] );
133+
134+
// Optional: disable the admin settings page so the plugin is configured only programmatically.
135+
define( 'ROLLBAR_DISABLE_ADMIN', true );
81136
```
82-
3. Issue command `composer install` in the root directory of your WordPress project.
83-
4. In `Plugins` → `Installed plugins` find `Rollbar` and click `Activate` underneath.
84-
5. Log into your [Rollbar account dashboard](https://rollbar.com/login/).
85-
6. Go to `Settings` → `Project Access Tokens`.
86-
7. Copy the token value under `post_client_item` and `post_server_item`.
87-
8. Navigate to `Tools` → `Rollbar`.
88-
9. Enable `PHP error logging` and/or `Javascript error logging` depending on your needs.
89-
10. Paste the tokens you copied in step 7 in `Access Token` section.
90-
11. Provide the name of your environment in `Environment`. By default, the environment will be taken from `WP_ENV` environment variable if it's set otherwise it's blank.
91-
12. Pick a minimum logging level. Only errors at that or higher level will be reported. For reference: [PHP Manual: Predefined Error Constants](http://php.net/manual/en/errorfunc.constants.php).
92-
13. Click `Save Changes`.
93137

94138
== Frequently Asked Questions ==
95139

96140
= Multisite supported? =
97-
Yes of course. Additionally, you can assign different environments to each of your blogs.
141+
Yes, of course. Additionally, you can assign different environments to each of your blogs.
98142

99143
= I have a complex WordPress project and use composer for managing dependencies. Is your plugin composer friendly? =
100-
Yes. It's actually the recommended method of installation.
144+
Yes. It's actually the recommended method of installation. You can install the `rollbar/rollbar-php-wordpress` package
145+
using composer.
101146

102147
== Screenshots ==
103148

104-
1. Settings page
149+
1. Settings page.
105150

106151
== Changelog ==
107152

@@ -110,6 +155,7 @@ Yes. It's actually the recommended method of installation.
110155
* Removed support for PHP 8.0 and below.
111156
* Updated and improved the settings page.
112157
* Updated the Rollbar core PHP SDK to v4.1.
158+
* Updated the Rollbar core JavaScript SDK to v2.26.
113159
* Added support for telemetry and added auto-instrumentation.
114160
* Added support for `ROLLBAR_DISABLE_ADMIN` to remove the plugin settings page from the admin.
115161
* Added support for `ROLLBAR_SETTINGS` to configure the plugin without the admin page.
@@ -188,7 +234,7 @@ Yes. It's actually the recommended method of installation.
188234
* Updated rollbar-php dependency to v1.5.1
189235

190236
= Version 2.4.0 (17th May 2018) =
191-
* Added capture_ip, capture_email and capture_username to the config options.
237+
* Added capture_ip, capture_email, and capture_username to the config options.
192238
* Fixed populating config options from the database to the plugin for boolean values.
193239
* Updated rollbar-php dependency to v1.5.0
194240

@@ -307,7 +353,7 @@ Updated admin test results to show a skipped test as a success. Fixed new sessio
307353
* Updated rollbar-php dependency to v1.5.1
308354

309355
= Version 2.4.0 (5th April 2018) =
310-
* Added capture_ip, capture_email and capture_username to the config options.
356+
* Added capture_ip, capture_email, and capture_username to the config options.
311357
* Fixed populating config options from the database to the plugin for boolean values.
312358
* Updated rollbar-php dependency to v1.5.0
313359

0 commit comments

Comments
 (0)