|
1 | 1 | # jcdcdev.Umbraco.ReadingTime |
2 | 2 |
|
3 | | -[](https://github.com/jcdcdev/jcdcdev.Umbraco.ReadingTime/tree/main?tab=readme-ov-file#quick-start) |
4 | | -[](https://marketplace.umbraco.com/package/jcdcdev.umbraco.readingtime) |
5 | | -[](https://github.com/jcdcdev/jcdcdev.Umbraco.ReadingTime/blob/main/LICENSE) |
6 | | -[](https://www.nuget.org/packages/jcdcdev.Umbraco.ReadingTime/) |
| 3 | +[](https://github.com/jcdcdev/jcdcdev.Umbraco.ReadingTime/#quick-start) |
| 4 | +[](https://marketplace.umbraco.com/package/jcdcdev.Umbraco.ReadingTime) |
| 5 | +[](https://github.com/jcdcdev/jcdcdev.Umbraco.ReadingTime?tab=MIT-1-ov-file) |
| 6 | +[](https://www.nuget.org/packages/jcdcdev.Umbraco.ReadingTime) |
7 | 7 | [](https://jcdc.dev/umbraco-packages/reading-time) |
8 | 8 |
|
9 | | -Custom Data Type for calculating reading time. With full variant support! |
10 | 9 |
|
11 | | -The following editors are currently supported: |
12 | | - |
13 | | -- Rich Text |
14 | | -- Markdown |
15 | | -- Block Grid |
16 | | -- Block List |
17 | | -- Nested Content |
18 | | -- Textstring |
| 10 | +Custom Data Type for calculating reading time. With full variant support! |
| 11 | + |
| 12 | +The following editors are currently supported: |
| 13 | + |
| 14 | +- Rich Text |
| 15 | +- Markdown |
| 16 | +- Block Grid |
| 17 | +- Block List |
| 18 | +- Nested Content |
| 19 | +- Textstring |
19 | 20 | - Textarea |
20 | 21 |
|
| 22 | +## Quick Start |
| 23 | + |
| 24 | +1. Install the [NuGet package](https://www.nuget.org/packages/jcdcdev.Umbraco.ReadingTime) in your Umbraco CMS website project. |
| 25 | + ``` |
| 26 | + dotnet add package jcdcdev.Umbraco.ReadingTime |
| 27 | + ``` |
| 28 | +2. Add the Reading Time data type to a document type. You can configure: |
| 29 | + - `Words per minute` (default is 200) |
| 30 | + - `Min Unit` (default is Minute) |
| 31 | + - `Max Unit` (default is Minute) |
| 32 | +3. Save and publish content. |
| 33 | +4. Reading Time will display in the backoffice |
| 34 | + |
| 35 | +### Using the value in your templates |
| 36 | + |
| 37 | +In your template, you can accessing the Reading Time property value like any other property: |
| 38 | + |
| 39 | +```html |
| 40 | + @Model.ReadingTime.DisplayTime() |
| 41 | +``` |
| 42 | + |
| 43 | +## Configuration |
| 44 | + |
| 45 | +You can change the average words per minute in the data type settings. |
| 46 | + |
| 47 | +When creating a new data type, the default will be 200 words per minute. |
| 48 | + |
21 | 49 | ## Contributing |
22 | 50 |
|
23 | | -Contributions to this package are most welcome! Please read the [Contributing Guidelines](https://github.com/jcdcdev/jcdcdev.Umbraco.ReadingTime/blob/main/.github/CONTRIBUTING.md). |
| 51 | +Contributions to this package are most welcome! Please visit the [Contributing](https://github.com/jcdcdev/jcdcdev.Umbraco.ReadingTime/contribute) page. |
| 52 | + |
| 53 | +## Acknowledgements (Thanks) |
| 54 | + |
| 55 | +- LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter) |
| 56 | + |
24 | 57 |
|
25 | | -## Acknowledgments (thanks!) |
26 | 58 |
|
27 | | -- LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter) |
|
0 commit comments