Skip to content

[Doc] Improve README #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
smnandre merged 1 commit into from
Jul 12, 2026
Merged

[Doc] Improve README #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,14 +152,14 @@ $metrics = $analysis->getLoadingMetrics();

### Main Metrics

| # | Abbr | Metric | Description |
|------|--------------|-------------------------------|--------------------------------------------------------------------------------------------------|
| 🖼️ | **FCP** | **First Contentful Paint** | Time taken for the first piece of content to appear on the screen. |
| 📏 | **SI** | **Speed Index** | How quickly the contents of a page are visibly populated. |
| 📏 | **FID** | **First Input Delay** | |
| 📊 | **CLS** | **Cumulative Layout Shift** | Measure of visual stability; the sum of all individual layout shift scores. |
| ⏳ | **LCP** | **Largest Contentful Paint** | Time taken for the largest content element to appear. |
| ⏱️ | **INP** | Interaction to Next Paint | The time from when a user interacts with a page (e.g., clicks a button) to the next time the page visually updates in response to that interaction. |
| Abbr | Metric | Description |
|------|--------|-------------|
| **FCP** | **First Contentful Paint** | Time taken for the first piece of content to appear on the screen. |
| **SI** | **Speed Index** | How quickly the contents of a page are visibly populated. |
| **FID** | **First Input Delay** | Time from a user's first interaction to when the browser can respond. |
| **CLS** | **Cumulative Layout Shift** | Measure of visual stability; the sum of all individual layout shift scores. |
| **LCP** | **Largest Contentful Paint** | Time taken for the largest content element to appear. |
| **INP** | **Interaction to Next Paint** | Time from a user interaction to the next visual update in response. |


## Contributing
Expand All @@ -168,4 +168,4 @@ Contributions are welcome! If you would like to contribute, please fork the repo

## License

This project is licensed under the MIT License. See the LICENSE file for more information.
The MIT License (MIT). Please see [License File](LICENSE) for more information.
Loading