Skip to content

Commit 591cf9f

Browse files
committed
doc: Update README
1 parent a11f461 commit 591cf9f

File tree

1 file changed

+2
-39
lines changed

1 file changed

+2
-39
lines changed

.github/README.md

Lines changed: 2 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -18,48 +18,11 @@ The following editors are currently supported:
1818
- Textstring
1919
- Textarea
2020

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).
2323
2424
> Please review the [security policy](https://github.com/jcdcdev/jcdcdev.Umbraco.ReadingTime?tab=security-ov-file#supported-versions) for more information.
2525
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.
58-
59-
```csharp
60-
Model.ReadingTime.DisplayTime(minUnit: TimeUnit.Second, maxUnit: TimeUnit.Second)
61-
```
62-
6326
## Contributing
6427

6528
Contributions to this package are most welcome! Please visit the [Contributing](https://github.com/jcdcdev/jcdcdev.Umbraco.ReadingTime/contribute) page.

0 commit comments

Comments
 (0)