Skip to content

Commit

Permalink
Improved documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Michaelvilleneuve committed Dec 8, 2023
1 parent 3989671 commit 230613a
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand All @@ -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.

Expand Down

0 comments on commit 230613a

Please sign in to comment.