Skip to content

Commit

Permalink
Update README to reflect changes and add detail
Browse files Browse the repository at this point in the history
  • Loading branch information
geekwright committed Feb 15, 2021
1 parent 653bf12 commit 1d8287c
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ xWhoops25

A XOOPS 2.5.11+ extension that brings [whoops](https://github.com/filp/whoops) error display to XOOPS. It is especially handy for diagnosing failures brought on by unhandled errors, so you can more properly handle them.

Administrators will always have access to the extended diagnotics, and other groups can also be granted access.
Administrators control access to the extended diagnotics, and any group can be granted or denied access.

Outside of the control panel, there is no user interface. It will "just work" when needed.

Expand All @@ -14,3 +14,12 @@ To add *xwhoops25* to your XoopsCore25, follow these steps
- open a terminal into that folder and execute
```composer install```
- install the xwhoops25 module in the system administration module page
- grant access by selecting groups in the permissions section

The Whoops display contains 4 main sections.
- *top left* is the error that was encountered
- *lower left* shows the stack frames, the trace of path of the processing that resulted in the error.
- *top right* shows the code for the currently selected stack frame item. Select a new stack frame to see the related code.
- *lower right* shows environment information such as request parameters, session information, etc.

Note: if the XoopsLogger is enabled, MySQL queries will be shown in the Environment & details section.

0 comments on commit 1d8287c

Please sign in to comment.