Skip to content

Commit

Permalink
readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
leventcz committed May 14, 2024
1 parent 4134dfa commit b7af662
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
<p align="center"><img src="/art/top.gif" alt="Top in action"></p>
<p align="center"><img src="/art/top.gif" alt="Real-time monitoring with Laravel Top"></p>

```php
php artisan top
```
**Top** provides real-time monitoring directly from the command line for Laravel applications. It allows you to track essential metrics and the busiest routes with ease.
**Top** provides real-time monitoring directly from the command line for Laravel applications.
It is designed for use in production environments, allowing you to track essential metrics and the busiest routes with ease.

## Installation via Composer

Expand Down Expand Up @@ -45,7 +46,7 @@ If you want to access metrics in your application, you can use the **Top** facad
use Leventcz\Top\Facades\Top;
use Leventcz\Top\Data\Route;

$requestSummary = Top::requests();
$requestSummary = Top::http();
$requestSummary->averageRequestPerSecond;
$requestSummary->averageMemoryUsage;
$requestSummary->averageDuration;
Expand All @@ -59,7 +60,7 @@ $cacheSummary->averageHitPerSecond;
$cacheSummary->averageMissPerSecond;
$cacheSummary->averageWritePerSecond;

$topRoutes = Top::http();
$topRoutes = Top::routes();
$topRoutes->each(function(Route $route) {
$route->uri;
$route->method;
Expand All @@ -68,6 +69,9 @@ $topRoutes->each(function(Route $route) {
$route->averageDuration;
})
```
## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Testing

Expand Down

0 comments on commit b7af662

Please sign in to comment.