Skip to content

Commit eb7ce90

Browse files
docs: improve README with features section, badges and version table
- Add License and PHP Version badges - Add Features section highlighting plugin capabilities - Add Livewire column to version compatibility table - Add PHP version and Filament version to Requirements section - Improve description and Configuration section wording Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 00b3c87 commit eb7ce90

1 file changed

Lines changed: 25 additions & 11 deletions

File tree

README.md

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,34 @@
99
[![Latest Version on Packagist](https://img.shields.io/packagist/v/jeffersongoncalves/filament-metrics-fathom.svg?style=flat-square)](https://packagist.org/packages/jeffersongoncalves/filament-metrics-fathom)
1010
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/jeffersongoncalves/filament-metrics-fathom/phpstan.yml?branch=3.x&label=phpstan&style=flat-square)](https://github.com/jeffersongoncalves/filament-metrics-fathom/actions?query=workflow%3Aphpstan+branch%3A3.x)
1111
[![Total Downloads](https://img.shields.io/packagist/dt/jeffersongoncalves/filament-metrics-fathom.svg?style=flat-square)](https://packagist.org/packages/jeffersongoncalves/filament-metrics-fathom)
12+
[![License](https://img.shields.io/packagist/l/jeffersongoncalves/filament-metrics-fathom.svg?style=flat-square)](LICENSE.md)
13+
[![PHP Version](https://img.shields.io/packagist/php-v/jeffersongoncalves/filament-metrics-fathom.svg?style=flat-square)](https://packagist.org/packages/jeffersongoncalves/filament-metrics-fathom)
1214

13-
Filament plugin for **Fathom Analytics** metrics. Provides a settings page and dashboard widgets to visualize your website analytics directly in Filament.
15+
A [Filament](https://filamentphp.com) plugin that integrates [Fathom Analytics](https://usefathom.com) into your admin panel. Get real-time visitor counts, pageview charts, top pages, referrers, browsers, countries and device breakdowns — all from your Filament dashboard.
16+
17+
## Features
18+
19+
- Settings page to configure Fathom API credentials directly from the panel
20+
- 7 ready-to-use dashboard widgets (stats, charts, tables)
21+
- Real-time visitor count with automatic polling (every 30s)
22+
- Caching built-in to respect Fathom API rate limits (10 req/min)
23+
- Multi-language support (English and Brazilian Portuguese)
24+
- Fully configurable: enable/disable settings page and widgets independently
1425

1526
## Version Compatibility
1627

17-
| Plugin | Filament | Laravel | PHP |
18-
|--------|----------|---------|-----|
19-
| 1.x | 3.x | 10.x / 11.x | 8.2+ |
20-
| 2.x | 4.x | 11.x+ | 8.2+ |
21-
| **3.x** | **5.x** | **11.x+** | **8.2+** |
28+
| Plugin | Filament | Laravel | PHP | Livewire |
29+
|--------|----------|---------|-----|----------|
30+
| 1.x | 3.x | 10.x / 11.x | 8.2+ | 3.x |
31+
| 2.x | 4.x | 11.x+ | 8.2+ | 3.x |
32+
| **3.x** | **5.x** | **11.x+** | **8.2+** | **4.x** |
2233

2334
## Requirements
2435

25-
- [jeffersongoncalves/laravel-metrics-fathom](https://github.com/jeffersongoncalves/laravel-metrics-fathom) `^1.0`
26-
- [filament/spatie-laravel-settings-plugin](https://filamentphp.com/plugins/filament-spatie-settings) `^5.0`
36+
- PHP 8.2+
37+
- [Filament](https://filamentphp.com) ^5.0
38+
- [jeffersongoncalves/laravel-metrics-fathom](https://github.com/jeffersongoncalves/laravel-metrics-fathom) ^1.0
39+
- [filament/spatie-laravel-settings-plugin](https://filamentphp.com/plugins/filament-spatie-settings) ^5.0
2740

2841
## Installation
2942

@@ -53,9 +66,9 @@ public function panel(Panel $panel): Panel
5366
}
5467
```
5568

56-
## Configuration Options
69+
## Configuration
5770

58-
You can disable the settings page or widgets:
71+
You can enable or disable features individually:
5972

6073
```php
6174
FathomMetricsPlugin::make()
@@ -78,9 +91,10 @@ The plugin provides 7 dashboard widgets:
7891
| **Top Devices** | Device type distribution (desktop, mobile, tablet) | Doughnut Chart |
7992

8093
All widgets include:
94+
8195
- Automatic error handling with user-friendly messages
8296
- "Not Configured" state when API token is missing
83-
- Caching to respect Fathom API rate limits (10 req/min)
97+
- Built-in caching to respect Fathom API rate limits
8498
- Multi-language support (English and Portuguese)
8599

86100
## Translations

0 commit comments

Comments
 (0)