From 230613a222d18a06fa6c5361452f11acdfc5609f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Villeneuve?= Date: Fri, 8 Dec 2023 15:28:47 +0100 Subject: [PATCH] Improved documentation --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 57518cd..75131ca 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ end ``` ## Simple usage -### Defining a simple counter +### Basic counter This will simply increment the counter every time a `User` is created. @@ -87,7 +87,7 @@ UsersCreated.values_grouped_by_month(stop_at: Time.now.last_month.end_of_month, # } ``` -### Defining a counter with a scope +### Scoped counter Imagine you have a `User` model that belongs to an `Organisation` and you want to count the number of users created per organisation. @@ -110,7 +110,7 @@ UsersCreated.value(scope: Organisation.first) UsersCreated.values_grouped_by_month(scope: Organisation.first) ``` -### Defining an aggregation based stat +### Aggregation based statistics This is useful when you want to get an average or sum of a value.