+semver: minor

Author: jcdcdev

.github/README.md

@@ -5,7 +5,7 @@
 [![GitHub license](https://img.shields.io/github/license/jcdcdev/jcdcdev.Umbraco.ReadingTime?color=8AB803)](../LICENSE)
 [![Downloads](https://img.shields.io/nuget/dt/jcdcdev.Umbraco.ReadingTime?color=cc9900)](https://www.nuget.org/packages/jcdcdev.Umbraco.ReadingTime/)
 
-Custom Data Type for calculating reading time.
+Custom Data Type for calculating reading time. With full variant support! 
 
 The following editors are currently supported:
 
@@ -20,23 +20,40 @@ The following editors are currently supported:
 ## Quick Start
 
 1. Install the [NuGet package](https://www.nuget.org/packages/jcdcdev.Umbraco.ReadingTime) in your Umbraco CMS website project.
-2. Add the Reading Time data type to a document type.
-   - Note: You can configure the words per minute in the data type settings.
+   ```
+    dotnet add package jcdcdev.Umbraco.ReadingTime
+   ```
+2. Add the Reading Time data type to a document type. You can configure:
+   - `Words per minute` (default is 200)
+   - `Min Unit` (default is Minute)
+   - `Max Unit` (default is Minute)
+     ![A screenshot of the BackOffice showing Reading Time data type](https://raw.githubusercontent.com/jcdcdev/jcdcdev.Umbraco.ReadingTime/main/docs/screenshots/datatype.png)
 3. Save and publish content.
 4. Reading Time will display in the backoffice
 
-![A screenshot of the BackOffice showing Reading Time](https://raw.githubusercontent.com/jcdcdev/jcdcdev.Umbraco.ReadingTime/main/docs/screenshots/backoffice.png)
+   ![A screenshot of the BackOffice showing Reading Time](https://raw.githubusercontent.com/jcdcdev/jcdcdev.Umbraco.ReadingTime/main/docs/screenshots/backoffice.png)
 
 ## Using the value in your templates
 
-In your template, you can accessing the Reading Time property.
+In your template, you can accessing the Reading Time property value like any other property:
+
+```html
+ @Model.ReadingTime.DisplayTime()
+```
+
+![A screenshot of page showing Reading Time](https://raw.githubusercontent.com/jcdcdev/jcdcdev.Umbraco.ReadingTime/main/docs/screenshots/displaytime.png)
+
+### Overriding the default display
+The `DisplayTime` method will format the reading time as a string using [Humanizer](https://github.com/Humanizr/Humanizer). This supports variants, meaning the reading time will be displayed based on the pluralisation rules of the current culture (e.g. "1 minute", "2 minutes", "0 minuter").
+
+Min and max `TimeUnit` values are derived from the Data Type settings. The below example shows how you can ensure only seconds are displayed.
 
 ```csharp
-<div class="alert alert-info">
-    Read in @Model.ReadingTime.DisplayTime()
-</div>
+ Model.ReadingTime.DisplayTime(minUnit: TimeUnit.Second, maxUnit: TimeUnit.Second)
 ```
 
+
+
 ## Configuration
 
 You can change the average words per minute in the data type settings.
@@ -57,6 +74,10 @@ When creating a new data type, the default will be 200 words per minute. To chan
 
 Draft content is _not_ included in the calculation.
 
+**Words per minute applies to all variants.**
+
+It is not currently possible to configure words per minute per culture.
+
 ## Extending
 
 You can extend the data type to support additional editors by implementing the `IReadingTimeValueProvider` interface.
@@ -93,6 +114,7 @@ public class Composer : IComposer
     }
 }
 ```
+
 ## Contributing
 
 Contributions to this package are most welcome! Please read the [Contributing Guidelines](CONTRIBUTING.md).

.github/dependabot.yml

@@ -0,0 +1,19 @@
+version: 2
+updates:
+  - package-ecosystem: nuget
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "04:00"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+
+  - package-ecosystem: npm
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "04:00"
+    commit-message:
+      prefix: "chore"
+      include: "scope"

.github/workflows/release.yml

@@ -1,8 +1,5 @@
 name: Release
 on:
-  pull_request:
-    branches: "main"
-    types: [ closed ]
   workflow_dispatch:
 jobs:
   build:

.gitignore

@@ -353,6 +353,8 @@ MigrationBackup/
 .ionide/
 
 # Rider
+src/.idea
 *.sqlite.db*
 .idea/
 *.csproj.DotSettings
+**/umbraco/Data/TEMP/

docs/screenshots/backoffice.png

@@ -1,8 +1,12 @@
 [*]
 max_line_length = 200
-indent_style = tab
+indent_style = space
 indent_size = 4
 tab_width = 4
+insert_final_newline = true
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
 
 # ReSharper properties
 resharper_braces_redundant = false

docs/screenshots/datatype.png

@@ -7,4 +7,4 @@ public class Composer : IComposer
     public void Compose(IUmbracoBuilder builder)
     {
     }
-}
+}