Skip to content

Commit fd8ceba

Browse files
committed
readme: added jumbo
1 parent f6ea705 commit fd8ceba

File tree

1 file changed

+22
-12
lines changed

1 file changed

+22
-12
lines changed

readme.md

+22-12
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,21 @@
1-
[Tracy](https://tracy.nette.org) - PHP debugger
2-
==============================================
1+
[![Tracy](https://github.com/nette/tracy/assets/194960/f36323d8-486c-4a5e-b3f1-f97cd7c082ca)](https://tracy.nette.org)
32

43
[![Downloads this Month](https://img.shields.io/packagist/dm/tracy/tracy.svg)](https://packagist.org/packages/tracy/tracy)
54
[![Tests](https://github.com/nette/tracy/workflows/Tests/badge.svg?branch=master)](https://github.com/nette/tracy/actions)
65
[![Build Status Windows](https://ci.appveyor.com/api/projects/status/github/nette/tracy?branch=master&svg=true)](https://ci.appveyor.com/project/dg/tracy/branch/master)
76
[![Latest Stable Version](https://poser.pugx.org/tracy/tracy/v/stable)](https://github.com/nette/tracy/releases)
87
[![License](https://img.shields.io/badge/license-New%20BSD-blue.svg)](https://github.com/nette/tracy/blob/master/license.md)
98

9+
 <!---->
1010

1111
Introduction
1212
------------
1313

1414
Tracy library is a useful helper for everyday PHP programmers. It helps you to:
1515

16-
- quickly detect and correct errors
17-
- log errors
18-
- dump variables
19-
- measure execution time of scripts/queries
20-
- see memory consumption
16+
✅ designed to facilitate debugging PHP code<br>
17+
✅ hints and corrects you just like a good friend watching your back<br>
18+
✅ damn cool visualization of errors
2119

2220

2321
PHP is a perfect language for making hardly detectable errors because it gives great flexibility to programmers. Tracy\Debugger is more valuable because of that. It is an ultimate tool among the diagnostic ones.
@@ -26,6 +24,7 @@ If you are meeting Tracy for the first time, believe me, your life starts to be
2624

2725
Documentation can be found on the [website](https://tracy.nette.org).
2826

27+
 <!---->
2928

3029
[Support Tracy](https://github.com/sponsors/dg)
3130
-----------------------------------------------
@@ -36,6 +35,7 @@ Do you like Tracy? Are you looking forward to the new features?
3635

3736
Thank you!
3837

38+
 <!---->
3939

4040
Installation and Requirements
4141
-----------------------------
@@ -48,12 +48,9 @@ composer require tracy/tracy
4848

4949
Alternatively, you can download the whole package or [tracy.phar](https://github.com/nette/tracy/releases) file.
5050

51-
| Tracy | compatible with PHP | compatible with browsers
52-
|-----------|---------------|----------
53-
| Tracy 3.0 | PHP 8.0 – 8.3 | Chrome 112+, Firefox 117+, Safari 16.5+
54-
| Tracy 2.10| PHP 8.0 – 8.3 | Chrome 64+, Firefox 69+, Safari 15.4+
55-
| Tracy 2.9 | PHP 7.2 – 8.2 | Chrome 64+, Firefox 69+, Safari 13.1+
51+
Tracy 2.10 is compatible with PHP 8.0 to 8.3.
5652

53+
 <!---->
5754

5855
Usage
5956
-----
@@ -71,6 +68,7 @@ Debugger::enable();
7168
The first thing you'll notice on the page is the Tracy Bar in the bottom right corner. If you don't see it, it may mean that Tracy is running in production mode.
7269
This is because Tracy is only visible on localhost for security reasons. To test if it works, you can temporarily put it into development mode using the `Debugger::enable(Debugger::Development)` parameter.
7370

71+
 <!---->
7472

7573
Tracy Bar
7674
---------
@@ -87,6 +85,7 @@ If you do not want to show Tracy Bar, set:
8785
Debugger::$showBar = false;
8886
```
8987

88+
 <!---->
9089

9190
Visualization of Errors and Exceptions
9291
--------------------------------------
@@ -135,6 +134,7 @@ Debugger::$strictMode = E_ALL & ~E_DEPRECATED & ~E_USER_DEPRECATED; // all error
135134

136135
Note: Tracy when activated changes the error reporting level to E_ALL. If you want to change this, do so after calling `enable()`.
137136

137+
 <!---->
138138

139139
Development vs Production Mode
140140
------------------------------
@@ -163,6 +163,7 @@ You can also directly set the development/production mode using the `Debugger::D
163163

164164
(If you use the Nette Framework, take a look at how to set the mode for it, and it will then also be used for Tracy.)
165165

166+
 <!---->
166167

167168
Error Logging
168169
-------------
@@ -205,12 +206,14 @@ Debugger::$email = '[email protected]';
205206

206207
To protect your e-mail box from flood, Tracy sends **only one message** and creates a file `email-sent`. When a developer receives the e-mail notification, he checks the log, corrects his application and deletes the `email-sent` monitoring file. This activates the e-mail sending again.
207208

209+
 <!---->
208210

209211
Opening Files in the Editor
210212
---------------------------
211213

212214
When the error page is displayed, you can click on file names and they will open in your editor with the cursor on the corresponding line. Files can also be created (action `create file`) or bug fixed in them (action `fix it`). In order to do this, you need to [configure the browser and the system](https://tracy.nette.org/cs/open-files-in-ide).
213215

216+
 <!---->
214217

215218
Variable Dumping
216219
----------------
@@ -262,6 +265,7 @@ bdump([1, 3, 5, 7, 9], 'odd numbers up to ten');
262265

263266
![bar dump](https://nette.github.io/tracy/images/bardump-en.webp)
264267

268+
 <!---->
265269

266270
Stopwatch
267271
---------
@@ -299,6 +303,7 @@ Debugger::timer(); // runs the timer
299303
echo Debugger::timer(); // elapsed time in seconds
300304
```
301305

306+
 <!---->
302307

303308
Custom Logger
304309
-------------
@@ -330,6 +335,7 @@ services:
330335
tracy.logger: SlackLogger
331336
```
332337

338+
 <!---->
333339

334340
Monolog Integration
335341
-------------------
@@ -348,6 +354,7 @@ Debugger::log('info'); // writes: [<TIMESTAMP>] main-channel.INFO: info [] []
348354
Debugger::log('warning', Debugger::WARNING); // writes: [<TIMESTAMP>] main-channel.WARNING: warning [] []
349355
```
350356

357+
 <!---->
351358

352359
Faster Loading
353360
--------------
@@ -366,6 +373,7 @@ The solution is to place `<?php Tracy\Debugger::renderLoader() ?>` into your tem
366373
</head>
367374
```
368375

376+
 <!---->
369377

370378
AJAX and Redirected Requests
371379
----------------------------
@@ -395,6 +403,7 @@ Debugger::dispatch();
395403

396404
The `setSessionStorage()` function has existed since version 2.9, before that Tracy always used the native PHP session.
397405

406+
 <!---->
398407

399408
Content Security Policy
400409
-----------------------
@@ -433,6 +442,7 @@ change it to
433442
try_files $uri $uri/ /index.php$is_args$args;
434443
```
435444

445+
 <!---->
436446

437447
Integrations
438448
------------

0 commit comments

Comments
 (0)