Skip to content

Commit c20b0f8

Browse files
jcdcdevjcdcdev
authored
Merge pull request #22 from jcdcdev/dev/v13
doc: README
2 parents f36e283 + 385cab8 commit c20b0f8

File tree

5 files changed

+39
-12
lines changed

5 files changed

+39
-12
lines changed

‎.github/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# jcdcdev.Umbraco.ReadingTime
22

3-
[![Umbraco Version](https://img.shields.io/badge/Umbraco-10.4+-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/jcdcdev.umbraco.readingtime)
4-
[![GitHub license](https://img.shields.io/github/license/jcdcdev/jcdcdev.Umbraco.ReadingTime?color=8AB803&label=License)](https://github.com/jcdcdev/jcdcdev.Umbraco.ReadingTime/blob/main/LICENSE)
5-
[![NuGet Downloads](https://img.shields.io/nuget/dt/jcdcdev.Umbraco.ReadingTime?color=cc9900&label=NuGet)](https://www.nuget.org/packages/jcdcdev.Umbraco.ReadingTime/)
3+
[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco-Marketplace-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/jcdcdev.umbraco.readingtime)
4+
[![GitHub License](https://img.shields.io/github/license/jcdcdev/jcdcdev.Umbraco.ReadingTime?color=8AB803&label=License&logo=github)](https://github.com/jcdcdev/jcdcdev.Umbraco.ReadingTime/blob/main/LICENSE)
5+
[![NuGet Downloads](https://img.shields.io/nuget/dt/jcdcdev.Umbraco.ReadingTime?color=cc9900&label=Downloads&logo=nuget)](https://www.nuget.org/packages/jcdcdev.Umbraco.ReadingTime/)
66

77
Custom Data Type for calculating reading time. With full variant support!
88

@@ -116,7 +116,7 @@ public class Composer : IComposer
116116

117117
## Contributing
118118

119-
Contributions to this package are most welcome! Please read the [Contributing Guidelines](CONTRIBUTING.md).
119+
Contributions to this package are most welcome! Please read the [Contributing Guidelines](https://github.com/jcdcdev/jcdcdev.Umbraco.ReadingTime/blob/main/.github/CONTRIBUTING.md).
120120

121121
## Acknowledgments (thanks!)
122122

‎.github/workflows/build.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ on:
55
workflow_dispatch:
66
jobs:
77
metadata:
8-
uses: jcdcdev/jcdcdev.Github.UmbracoSimpleDeploy/.github/workflows/generate-project-metadata.yml@dev
8+
uses: jcdcdev/jcdcdev.Github.UmbracoSimpleDeploy/.github/workflows/generate-project-metadata.yml@main
99
build:
1010
runs-on: ubuntu-latest
1111
needs:

‎docs/README_nuget.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# jcdcdev.Umbraco.ReadingTime
2+
3+
[![Documentation](https://img.shields.io/badge/Docs-Quickstart-394933?style=flat&logo=github)](https://github.com/jcdcdev/jcdcdev.Umbraco.ReadingTime/tree/main?tab=readme-ov-file#quick-start)
4+
[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco-Marketplace-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/jcdcdev.umbraco.readingtime)
5+
[![GitHub License](https://img.shields.io/github/license/jcdcdev/jcdcdev.Umbraco.ReadingTime?color=8AB803&label=License&logo=github)](https://github.com/jcdcdev/jcdcdev.Umbraco.ReadingTime/blob/main/LICENSE)
6+
[![NuGet Downloads](https://img.shields.io/nuget/dt/jcdcdev.Umbraco.ReadingTime?color=cc9900&label=Downloads&logo=nuget)](https://www.nuget.org/packages/jcdcdev.Umbraco.ReadingTime/)
7+
8+
Custom Data Type for calculating reading time. With full variant support!
9+
10+
The following editors are currently supported:
11+
12+
- Rich Text
13+
- Markdown
14+
- Block Grid
15+
- Block List
16+
- Nested Content
17+
- Textstring
18+
- Textarea
19+
20+
## Contributing
21+
22+
Contributions to this package are most welcome! Please read the [Contributing Guidelines](https://github.com/jcdcdev/jcdcdev.Umbraco.ReadingTime/blob/main/.github/CONTRIBUTING.md).
23+
24+
## Acknowledgments (thanks!)
25+
26+
- LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter)

‎src/jcdcdev.Umbraco.ReadingTime.sln‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
99
..\.github\README.md = ..\.github\README.md
1010
Directory.Build.props = Directory.Build.props
1111
.editorconfig = .editorconfig
12+
..\docs\README_nuget.md = ..\docs\README_nuget.md
1213
EndProjectSection
1314
EndProject
1415
Global
@@ -17,10 +18,10 @@ Global
1718
Release|Any CPU = Release|Any CPU
1819
EndGlobalSection
1920
GlobalSection(ProjectConfigurationPlatforms) = postSolution
20-
{DB758ACE-77D4-4ED6-997A-B71AA5747E5E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
21-
{DB758ACE-77D4-4ED6-997A-B71AA5747E5E}.Debug|Any CPU.Build.0 = Debug|Any CPU
22-
{DB758ACE-77D4-4ED6-997A-B71AA5747E5E}.Release|Any CPU.ActiveCfg = Release|Any CPU
23-
{DB758ACE-77D4-4ED6-997A-B71AA5747E5E}.Release|Any CPU.Build.0 = Release|Any CPU
21+
{53BFA9E1-2748-4FEE-B3CB-98172460795D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
22+
{53BFA9E1-2748-4FEE-B3CB-98172460795D}.Debug|Any CPU.Build.0 = Debug|Any CPU
23+
{53BFA9E1-2748-4FEE-B3CB-98172460795D}.Release|Any CPU.ActiveCfg = Release|Any CPU
24+
{53BFA9E1-2748-4FEE-B3CB-98172460795D}.Release|Any CPU.Build.0 = Release|Any CPU
2425
{2060F159-0A7B-4484-A6C2-1995A3EF19B4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
2526
{2060F159-0A7B-4484-A6C2-1995A3EF19B4}.Debug|Any CPU.Build.0 = Debug|Any CPU
2627
{2060F159-0A7B-4484-A6C2-1995A3EF19B4}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -40,7 +41,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Github", "Github", "{5830A8
4041
..\.github\dependabot.yml = ..\.github\dependabot.yml
4142
EndProjectSection
4243
EndProject
43-
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestSite.13", "TestSite.13\TestSite.13.csproj", "{DB758ACE-77D4-4ED6-997A-B71AA5747E5E}"
44+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestSite.10", "TestSite.10\TestSite.10.csproj", "{53BFA9E1-2748-4FEE-B3CB-98172460795D}"
4445
EndProject
4546
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "jcdcdev.Umbraco.ReadingTime", "jcdcdev.Umbraco.ReadingTime\jcdcdev.Umbraco.ReadingTime.csproj", "{2060F159-0A7B-4484-A6C2-1995A3EF19B4}"
4647
EndProject

‎src/jcdcdev.Umbraco.ReadingTime/jcdcdev.Umbraco.ReadingTime.csproj‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<Copyright>$([System.DateTime]::UtcNow.ToString(`yyyy`)) © James Carter</Copyright>
1717
<PackageProjectUrl>https://jcdc.dev/umbraco-packages/reading-time</PackageProjectUrl>
1818
<RepositoryUrl>https://github.com/jcdcdev/jcdcdev.Umbraco.ReadingTime</RepositoryUrl>
19-
<PackageReadmeFile>README.md</PackageReadmeFile>
19+
<PackageReadmeFile>README_nuget.md</PackageReadmeFile>
2020
<RepositoryType>git</RepositoryType>
2121
<PackageLicenseExpression>MIT</PackageLicenseExpression>
2222
<PackageIcon>images\icon.png</PackageIcon>
@@ -40,6 +40,6 @@
4040

4141
<ItemGroup>
4242
<None Include="..\..\docs\icon.png" Pack="true" Visible="false" PackagePath="images\icon.png"/>
43-
<None Include="..\..\.github\README.md" Pack="true" PackagePath="\"/>
43+
<None Include="..\..\docs\README_nuget.md" Pack="true" PackagePath="\"/>
4444
</ItemGroup>
4545
</Project>

0 commit comments

Comments
 (0)