Skip to content

Commit 6c20aca

Browse files
committed
Docs.
1 parent c4de92c commit 6c20aca

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

LICENSE

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
The MIT License (MIT)
22

3+
Copyright (c) 2717 Mark Scherer
34
Copyright (c) 2014 Jad Bitar
45

56
Permission is hereby granted, free of charge, to any person obtaining a copy

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,17 @@ When using new Application.php and Middleware approach, you also need to adjust
3838

3939
That's it!
4040

41+
### Debug Mode
42+
An important note: This plugin is installed as require dependency, but even so it is more used as require-dev one.
43+
If the debug mode is off, it will completely ignore the Whoops handler, as without debug mode there is no exception to render.
44+
It will then display the public error message and only log internally.
45+
46+
So make sure you enable debug (locally) for checking out this package.
47+
For each error and exception you should then see the improved whoops handler output on your screen.
4148

4249
## Editor
43-
Opening the file via click in the editor is supported for most major IDEs.
50+
Opening the file in the editor via click in the browser is supported for most major IDEs.
51+
It uses `phpstorm://` URLs which can open the file through a command line call and directly jump to the right line.
4452

4553
Set your config as
4654
```php
@@ -58,11 +66,6 @@ If you are using a VM, e.g. CakeBox, you will also need the path mapping:
5866

5967
See the Wiki for more details on different OS and Browsers.
6068

61-
## License
62-
63-
Copyright (c)2015, Jad Bitar and licensed under [The MIT License][mit].
64-
65-
[CakePHP 3]:http://cakephp.org
66-
[Composer]:http://getcomposer.org
67-
[mit]:http://www.opensource.org/licenses/mit-license.php
68-
[Whoops]:http://filp.github.io/whoops/
69+
[CakePHP 3]:https://cakephp.org
70+
[Composer]:https://getcomposer.org
71+
[Whoops]:https://filp.github.io/whoops/

0 commit comments

Comments
 (0)