Skip to content

Commit

Permalink
DOC Update README.md for CMS 5
Browse files Browse the repository at this point in the history
  • Loading branch information
GuySartorelli committed Apr 19, 2023
1 parent 96ebe3a commit f3f04b9
Showing 1 changed file with 5 additions and 15 deletions.
20 changes: 5 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,11 @@
[![scrutinizer](https://scrutinizer-ci.com/g/lekoala/silverstripe-debugbar/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/lekoala/silverstripe-debugbar/)
[![Code coverage](https://codecov.io/gh/lekoala/silverstripe-debugbar/branch/master/graph/badge.svg)](https://codecov.io/gh/lekoala/silverstripe-debugbar)

## Requirements

* SilverStripe ^4.0
* [maximebf/php-debugbar](http://phpdebugbar.com)
* [jdorn/sql-formatter](https://github.com/jdorn/sql-formatter)

## Installation

You can install the debug bar with Composer:

```sh
composer require lekoala/silverstripe-debugbar
```
composer require --dev lekoala/silverstripe-debugbar
```

---

## Documentation

Expand Down Expand Up @@ -115,7 +105,7 @@ If a page request performance is more than a certain number of queries, a warnin

### System logs and messages

The "Messages" tab will show you a list of anything that has been processed by [a SilverStripe logger](https://docs.silverstripe.org/en/4/developer_guides/debugging/error_handling/) during a page execution:
The "Messages" tab will show you a list of anything that has been processed by [a SilverStripe logger](https://docs.silverstripe.org/en/developer_guides/debugging/error_handling/) during a page execution:

![System logs and messages](docs/_images/messages.png)

Expand Down Expand Up @@ -150,8 +140,8 @@ There is a variety of other useful information available via various tabs and in
* **Parameters:** Displays all GET, POST and ROUTE parameters from the current request
* **Config:** Displays a list of the current [SiteConfig](https://github.com/silverstripe/silverstripe-siteconfig) settings from the CMS
* **Requirements:** Shows a list of all [`Requirements`](https://docs.silverstripe.org/en/developer_guides/templates/requirements/) calls made during a page's execution
* **Middlewares:** Shows a list of all [`Middlewares`](https://docs.silverstripe.org/en/4/developer_guides/controllers/middlewares/) used for this request
* **Mails:** Shows a list of all [emails](https://docs.silverstripe.org/en/4/developer_guides/email/) sent
* **Middlewares:** Shows a list of all [`Middlewares`](https://docs.silverstripe.org/en/developer_guides/controllers/middlewares/) used for this request
* **Mails:** Shows a list of all [emails](https://docs.silverstripe.org/en/developer_guides/email/) sent
* **Headers:** Shows a list of all headers

#### Indicators
Expand Down

0 comments on commit f3f04b9

Please sign in to comment.