From edb4196252b7d3aed0fac8b68ebc56475309bb20 Mon Sep 17 00:00:00 2001
From: Arushad Ahmed <dash-8x@hotmail.com>
Date: Thu, 1 Aug 2024 14:42:56 +0600
Subject: [PATCH] - Added docs for predefined stats

---
 docs/intro.md                                 |  6 ---
 .../time-series/defining-time-series-stats.md | 45 +++++++++++++++++++
 docs/time-series/predefined-stats.md          | 38 ++++++++++++++++
 3 files changed, 83 insertions(+), 6 deletions(-)
 create mode 100644 docs/time-series/predefined-stats.md

diff --git a/docs/intro.md b/docs/intro.md
index 9c1fd11..4ada207 100644
--- a/docs/intro.md
+++ b/docs/intro.md
@@ -5,10 +5,4 @@ sidebar_position: 1.0
 
 # Stats
 
-:::danger
-
-This package is currently under development. If anything works, that's a surprise.
-
-:::
-
 [Stats](https://github.com/Javaabu/stats) Simplifies stats generation for Laravel. This package allows you to easily define time series statistics and visualize them through an interactive graph.
diff --git a/docs/time-series/defining-time-series-stats.md b/docs/time-series/defining-time-series-stats.md
index 7e49111..2a2c2ba 100644
--- a/docs/time-series/defining-time-series-stats.md
+++ b/docs/time-series/defining-time-series-stats.md
@@ -224,3 +224,48 @@ Instead of manually creating a sum stat class, you can use the provided `stats:t
 ```bash
 php artisan stats:time-series PaymentAmounts payment --type=sum
 ```
+
+# Login Stats
+
+`LoginsRepository` is an abstract stat class that can be used to display login counts for a specific user type. This stat uses data from [`spatie/laravel-activitylog`](https://github.com/spatie/laravel-activitylog) to generate the results. So you will need the `spatie/laravel-activitylog` package to use this type of stats. 
+
+```php
+<?php
+
+namespace App\Stats\TimeSeries;
+
+use App\Models\Customer;
+use Javaabu\Stats\Repositories\TimeSeries\LoginsRepository;
+
+class CustomerLoginsRepository extends LoginsRepository
+{
+
+    public function userModelClass(): string
+    {
+        return Customer::class;
+    }
+}
+```
+
+# Signup Stats
+
+`SignupsRepository` is an abstract stat class that can be used to display signup counts for a specific user type.
+
+```php
+<?php
+
+namespace App\Stats\TimeSeries;
+
+use App\Models\Customer;
+use Javaabu\Stats\Repositories\TimeSeries\SignupsRepository;
+
+class CustomerSignupsRepository extends SignupsRepository
+{
+
+    public function userModelClass(): string
+    {
+        return Customer::class;
+    }
+}
+
+```
diff --git a/docs/time-series/predefined-stats.md b/docs/time-series/predefined-stats.md
new file mode 100644
index 0000000..ed0ce20
--- /dev/null
+++ b/docs/time-series/predefined-stats.md
@@ -0,0 +1,38 @@
+---
+title: Predefined stats
+sidebar_position: 7
+---
+
+This package ships with several different predefined stats that might be useful.
+
+# Available Predefined Stats
+
+## user_signups
+
+Shows the counts for `App\Model\User` signups.
+
+## user_logins
+
+Shows the login counts for `App\Model\User`. Enabled only if `spatie/laravel-activitylog` package is installed.
+
+# Hiding Predefined Stats
+
+If you want to hide the predefined stats from the stats page, you can set the `merge` option to `false` when registering your stats.
+
+```php
+use \Javaabu\Stats\TimeSeriesStats;
+
+class AppServiceProvider extends ServiceProvider
+{   
+    /**
+     * Bootstrap any application services.
+     */
+    public function boot(): void
+    {       
+        TimeSeriesStats::register([           
+            'payments_count' => \App\Stats\TimeSeries\PaymentsCountRepository::class,
+            'payments_amount' => \App\Stats\TimeSeries\PaymentsAmountRepository::class,            
+        ], false);
+    }
+}
+```