You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/README.md
+2-39Lines changed: 2 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,48 +18,11 @@ The following editors are currently supported:
18
18
- Textstring
19
19
- Textarea
20
20
21
-
> [!IMPORTANT]
22
-
> Version 15 will only receive security updates and no new features.
21
+
> [!WARNING]
22
+
> Version 15 is no longer supported and is End of Life (EOL).
23
23
24
24
> Please review the [security policy](https://github.com/jcdcdev/jcdcdev.Umbraco.ReadingTime?tab=security-ov-file#supported-versions) for more information.
25
25
26
-
## Quick Start
27
-
28
-
1. Install the [NuGet package](https://www.nuget.org/packages/jcdcdev.Umbraco.ReadingTime) in your Umbraco CMS website project.
29
-
```
30
-
dotnet add package jcdcdev.Umbraco.ReadingTime
31
-
```
32
-
2. Add the Reading Time data type to a document type. You can configure:
33
-
-`Words per minute` (default is 200)
34
-
-`Min Unit` (default is Minute)
35
-
-`Max Unit` (default is Minute)
36
-
3. Save and publish content.
37
-
4. Reading Time will display in the backoffice
38
-
39
-
### Using the value in your templates
40
-
41
-
In your template, you can accessing the Reading Time property value like any other property:
42
-
43
-
```html
44
-
@Model.ReadingTime.DisplayTime()
45
-
```
46
-
47
-
## Configuration
48
-
49
-
You can change the average words per minute in the data type settings.
50
-
51
-
When creating a new data type, the default will be 200 words per minute.
52
-
53
-
## Extending
54
-
55
-
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").
56
-
57
-
Min and max `TimeUnit` values are derived from the Data Type settings. The below example shows how you can ensure only seconds are displayed.
Contributions to this package are most welcome! Please visit the [Contributing](https://github.com/jcdcdev/jcdcdev.Umbraco.ReadingTime/contribute) page.
0 commit comments