Merge pull request #22 from jcdcdev/dev/v13

doc: README
jcdcdev · May 25, 2024 · c20b0f8 · c20b0f8
2 parents f36e283 + 385cab8
commit c20b0f8
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 12 deletions.
diff --git a/.github/README.md b/.github/README.md
@@ -1,8 +1,8 @@
 # jcdcdev.Umbraco.ReadingTime
 
-[![Umbraco Version](https://img.shields.io/badge/Umbraco-10.4+-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/jcdcdev.umbraco.readingtime)
-[![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)
-[![NuGet Downloads](https://img.shields.io/nuget/dt/jcdcdev.Umbraco.ReadingTime?color=cc9900&label=NuGet)](https://www.nuget.org/packages/jcdcdev.Umbraco.ReadingTime/)
+[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco-Marketplace-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/jcdcdev.umbraco.readingtime)
+[![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)
+[![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/)
 
 Custom Data Type for calculating reading time. With full variant support! 
 
@@ -116,7 +116,7 @@ public class Composer : IComposer
 
 ## Contributing
 
-Contributions to this package are most welcome! Please read the [Contributing Guidelines](CONTRIBUTING.md).
+Contributions to this package are most welcome! Please read the [Contributing Guidelines](https://github.com/jcdcdev/jcdcdev.Umbraco.ReadingTime/blob/main/.github/CONTRIBUTING.md).
 
 ## Acknowledgments (thanks!)
 

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -5,7 +5,7 @@ on:
   workflow_dispatch:
 jobs:
   metadata:
-    uses: jcdcdev/jcdcdev.Github.UmbracoSimpleDeploy/.github/workflows/generate-project-metadata.yml@dev
+    uses: jcdcdev/jcdcdev.Github.UmbracoSimpleDeploy/.github/workflows/generate-project-metadata.yml@main
   build:
     runs-on: ubuntu-latest
     needs:

diff --git a/docs/README_nuget.md b/docs/README_nuget.md
@@ -0,0 +1,26 @@
+# jcdcdev.Umbraco.ReadingTime
+
+[![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)
+[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco-Marketplace-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/jcdcdev.umbraco.readingtime)
+[![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)
+[![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/)
+
+Custom Data Type for calculating reading time. With full variant support!
+
+The following editors are currently supported:
+
+- Rich Text
+- Markdown
+- Block Grid
+- Block List
+- Nested Content
+- Textstring
+- Textarea
+
+## Contributing
+
+Contributions to this package are most welcome! Please read the [Contributing Guidelines](https://github.com/jcdcdev/jcdcdev.Umbraco.ReadingTime/blob/main/.github/CONTRIBUTING.md).
+
+## Acknowledgments (thanks!)
+
+- LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter)
diff --git a/src/jcdcdev.Umbraco.ReadingTime.sln b/src/jcdcdev.Umbraco.ReadingTime.sln
@@ -9,6 +9,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		..\.github\README.md = ..\.github\README.md
 		Directory.Build.props = Directory.Build.props
 		.editorconfig = .editorconfig
+		..\docs\README_nuget.md = ..\docs\README_nuget.md
 	EndProjectSection
 EndProject
 Global
@@ -17,10 +18,10 @@ Global
 		Release|Any CPU = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
-		{DB758ACE-77D4-4ED6-997A-B71AA5747E5E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{DB758ACE-77D4-4ED6-997A-B71AA5747E5E}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{DB758ACE-77D4-4ED6-997A-B71AA5747E5E}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{DB758ACE-77D4-4ED6-997A-B71AA5747E5E}.Release|Any CPU.Build.0 = Release|Any CPU
+		{53BFA9E1-2748-4FEE-B3CB-98172460795D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{53BFA9E1-2748-4FEE-B3CB-98172460795D}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{53BFA9E1-2748-4FEE-B3CB-98172460795D}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{53BFA9E1-2748-4FEE-B3CB-98172460795D}.Release|Any CPU.Build.0 = Release|Any CPU
 		{2060F159-0A7B-4484-A6C2-1995A3EF19B4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{2060F159-0A7B-4484-A6C2-1995A3EF19B4}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{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
 		..\.github\dependabot.yml = ..\.github\dependabot.yml
 	EndProjectSection
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestSite.13", "TestSite.13\TestSite.13.csproj", "{DB758ACE-77D4-4ED6-997A-B71AA5747E5E}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestSite.10", "TestSite.10\TestSite.10.csproj", "{53BFA9E1-2748-4FEE-B3CB-98172460795D}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "jcdcdev.Umbraco.ReadingTime", "jcdcdev.Umbraco.ReadingTime\jcdcdev.Umbraco.ReadingTime.csproj", "{2060F159-0A7B-4484-A6C2-1995A3EF19B4}"
 EndProject
diff --git a/src/jcdcdev.Umbraco.ReadingTime/jcdcdev.Umbraco.ReadingTime.csproj b/src/jcdcdev.Umbraco.ReadingTime/jcdcdev.Umbraco.ReadingTime.csproj
@@ -16,7 +16,7 @@
         <Copyright>$([System.DateTime]::UtcNow.ToString(`yyyy`)) © James Carter</Copyright>
         <PackageProjectUrl>https://jcdc.dev/umbraco-packages/reading-time</PackageProjectUrl>
         <RepositoryUrl>https://github.com/jcdcdev/jcdcdev.Umbraco.ReadingTime</RepositoryUrl>
-        <PackageReadmeFile>README.md</PackageReadmeFile>
+        <PackageReadmeFile>README_nuget.md</PackageReadmeFile>
         <RepositoryType>git</RepositoryType>
         <PackageLicenseExpression>MIT</PackageLicenseExpression>
         <PackageIcon>images\icon.png</PackageIcon>
@@ -40,6 +40,6 @@
 
     <ItemGroup>
         <None Include="..\..\docs\icon.png" Pack="true" Visible="false" PackagePath="images\icon.png"/>
-        <None Include="..\..\.github\README.md" Pack="true" PackagePath="\"/>
+        <None Include="..\..\docs\README_nuget.md" Pack="true" PackagePath="\"/>
     </ItemGroup>
 </Project>