diff --git a/README.md b/README.md index c227283..63f7bc0 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,62 @@ ![Laps v3 toolbar screenshot](https://i.imgur.com/NtgAxhp.png) -# Laps — light WordPress profiler +# Laps — könnyűsúlyú WordPress profilozó -_Make a site, make it fast._ +> *Készíts egy weboldalt, és tedd gyorssá.* -[![Tests Status](https://github.com/rarst/laps/actions/workflows/tests.yml/badge.svg)](https://github.com/Rarst/laps/actions/workflows/tests.yml) -[![Total Downloads](https://img.shields.io/packagist/dt/rarst/laps.svg)](https://packagist.org/packages/rarst/laps) -[![Latest Stable Version](https://img.shields.io/packagist/v/rarst/laps.svg?label=version)](https://packagist.org/packages/rarst/laps) -[![PHP from Packagist](https://img.shields.io/packagist/php-v/rarst/laps.svg)](https://packagist.org/packages/rarst/laps) -[![Download Laps](https://img.shields.io/badge/download-laps.zip-blue)](https://github.com/Rarst/laps/releases/latest/download/laps.zip) +A Laps egy gyors és könnyű WordPress bővítmény, amely valós idejű betöltési és teljesítményadatokat jelenít meg közvetlenül az admin eszköztáron (toolbar). -Laps is a plugin that **shows performance information** about WordPress page load. +## Főbb funkciók -It provides a visual summary in toolbar that is quick and easy to inspect. +### Oldalprofilozás +A Laps automatikusan méri és megjeleníti a kulcsfontosságú eseményeket: +- PHP, WordPress mag, bővítmények és sablonok betöltési ideje, fő ciklus (loop), oldalsávok (sidebars) +- Adatbázis-lekérdezések és hívási láncok részletes listázása (ha a `SAVEQUERIES` konstans értéke `true`) +- Külső hálózati kérések (HTTP API hívások más oldalakra) -## Page profiling - -Laps automatically tracks many events, such as: -- PHP, core, plugins, and themes load, main posts loop, sidebars -- database queries (with [`SAVEQUERIES` defined constant set to true](https://wordpress.org/support/article/debugging-in-wordpress/#savequeries)) -- network requests to other sites - -## API profiling - -For Ajax and REST API — Laps outputs performance information by Server Timing API, for use with clients such as Chrome Dev Tools. +### API mérés (Ajax & REST API) +Ajax és REST API kérések esetén a Laps a **Server Timing API** segítségével küldi el a mérési adatokat, amelyek közvetlenül megtekinthetők a böngésző fejlesztői eszköztárában (pl. Chrome DevTools Network fülön). ![Laps v3 dev tools screenshot](https://i.imgur.com/hkl1Qk9.png) -### API authentication +### Jogosultságok +A teljesítményadatok és a kapcsolódó stílusok/scriptek alapértelmezetten csak a megfelelő adminisztrátori jogosultsággal rendelkező felhasználóknak jelennek meg. A megjelenítés testreszabható a `laps_can_see` szűrővel (filter). -API requests need to be authenticated as admin for performance data to be sent. For Ajax requests cookies are sufficient. REST API requests also [need nonce passed](https://developer.wordpress.org/rest-api/using-the-rest-api/authentication/#cookie-authentication). +## Telepítés -`laps_can_see` check can be filtered to relax required permissions on the plugin’s side. +1. Töltsd le a legfrissebb `laps.zip` archívumot a **Releases** oldalról. +2. A WordPress admin felületén válaszd a **Bővítmények → Új hozzáadása → Bővítmény feltöltése** menüpontot. +3. Töltsd fel a `laps.zip` fájlt, majd aktiváld. -## Installation +## Követelmények +- **WordPress:** 7.0 vagy újabb +- **PHP:** 7.4 vagy újabb -| [Composer](https://getcomposer.org/) (recommended) | Release archive | -| -------------------------------------------------- | -------- | -| `composer require rarst/laps` | [![Download Laps](https://img.shields.io/badge/download-laps.zip-blue?style=for-the-badge)](https://github.com/Rarst/laps/releases/latest/download/laps.zip)| +--- -## Tests +## English -Tests require [Brain Monkey](https://github.com/Brain-WP/BrainMonkey) (included in dependencies) and PHPUnit 8 (not included). +# Laps — Light WordPress Profiler -```bash -phpunit -``` +> *Make a site, make it fast.* + +Laps is a lightweight plugin that displays real-time page load and performance information directly in the admin toolbar. + +### Features +- **Page profiling:** Automatically tracks PHP baseline, core initialization, plugin and theme load times, the main query loop, and sidebars. +- **Database queries:** Detailed query logs and execution times (when `SAVEQUERIES` is defined and set to `true`). +- **HTTP requests:** Tracks external network requests made via the WordPress HTTP API. +- **API profiling:** Emits Server Timing API headers for Ajax and REST API requests, inspectable directly in browser DevTools. +- **Access control:** Metrics and frontend/admin assets are only exposed to users with administrative capabilities (customizable via the `laps_can_see` filter). + +### Installation +1. Download the latest `laps.zip` from the **Releases** page. +2. In the WordPress Admin, go to **Plugins → Add New → Upload Plugin**. +3. Upload `laps.zip` and activate. + +### Requirements +- **WordPress:** 7.0 or higher +- **PHP:** 7.4 or higher ## License - MIT