doc: README

jcdcdev · May 25, 2024 · c570afe · c570afe
1 parent 1ba9d1a
commit c570afe
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 12 deletions.
diff --git a/.github/README.md b/.github/README.md
@@ -1,13 +1,7 @@
 # jcdcdev.Umbraco.Core
 
-[![Umbraco Version](https://img.shields.io/badge/Umbraco-10.4+-%233544B1?style=flat&logo=umbraco)](https://umbraco.com/products/umbraco-cms/)
-[![GitHub license](https://img.shields.io/github/license/jcdcdev/jcdcdev.Umbraco.Core?color=8AB803&label=License)](https://github.com/jcdcdev/jcdcdev.Umbraco.Core/blob/main/LICENSE)
-[![NuGet Downloads](https://img.shields.io/nuget/dt/jcdcdev.Umbraco.Core?color=cc9900&label=NuGet)](https://www.nuget.org/packages/jcdcdev.Umbraco.Core/)
+[![Documentation](https://img.shields.io/badge/Docs-Quickstart-394933?style=flat&logo=github)](https://github.com/jcdcdev/jcdcdev.Umbraco.Core/tree/main?tab=readme-ov-file#quick-start)
+[![GitHub License](https://img.shields.io/github/license/jcdcdev/jcdcdev.Umbraco.Core?color=8AB803&label=License&logo=github)](https://github.com/jcdcdev/jcdcdev.Umbraco.Core/blob/main/LICENSE)
+[![NuGet Downloads](https://img.shields.io/nuget/dt/jcdcdev.Umbraco.Core?color=cc9900&label=Downloads&logo=nuget)](https://www.nuget.org/packages/jcdcdev.Umbraco.Core/)
 
-Core functionality used by my packages and projects
-
-| Package | Description | NuGet |
-| ------- | ----------- | ----- |
-|[Umbraco.Community.SimpleDashboards](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards) | This packages aims to help developers quickly put together Umbraco Dashboards using C# only. | [![NuGet](https://img.shields.io/nuget/vpre/Umbraco.Community.SimpleDashboards?color=0273B3)](https://www.nuget.org/packages/Umbraco.Community.SimpleDashboards) |
-| [Umbraco.Community.SimpleContentApps](https://github.com/jcdcdev/Umbraco.Community.SimpleContentApps) | This packages aims to help developers quickly put together Umbraco ContentApps using C# only. | [![NuGet](https://img.shields.io/nuget/vpre/Umbraco.Community.SimpleContentApps?color=0273B3)](https://www.nuget.org/packages/Umbraco.Community.SimpleContentApps) |
-| [Umbraco.Community.BackOfficeOrganiser](https://github.com/jcdcdev/Umbraco.Community.BackOfficeOrganiser) | Single-click (and opinionated) organiser for your backoffice | [![NuGet](https://img.shields.io/nuget/vpre/Umbraco.Community.BackOfficeOrganiser?color=0273B3)](https://www.nuget.org/packages/Umbraco.Community.BackOfficeOrganiser) |
+Core functionality used by my Umbraco CMS packages and projects.
diff --git a/docs/README_nuget.md b/docs/README_nuget.md
@@ -0,0 +1,7 @@
+# jcdcdev.Umbraco.Core
+
+[![Documentation](https://img.shields.io/badge/Docs-Quickstart-394933?style=flat&logo=github)](https://github.com/jcdcdev/jcdcdev.Umbraco.Core/tree/main?tab=readme-ov-file#quick-start)
+[![GitHub License](https://img.shields.io/github/license/jcdcdev/jcdcdev.Umbraco.Core?color=8AB803&label=License&logo=github)](https://github.com/jcdcdev/jcdcdev.Umbraco.Core/blob/main/LICENSE)
+[![NuGet Downloads](https://img.shields.io/nuget/dt/jcdcdev.Umbraco.Core?color=cc9900&label=Downloads&logo=nuget)](https://www.nuget.org/packages/jcdcdev.Umbraco.Core/)
+
+Core functionality used by my Umbraco CMS packages and projects.
diff --git a/src/jcdcdev.Umbraco.Core.sln b/src/jcdcdev.Umbraco.Core.sln
@@ -10,6 +10,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		Directory.Build.props = Directory.Build.props
 		.editorconfig = .editorconfig
 		build.ps1 = build.ps1
+		..\docs\README_nuget.md = ..\docs\README_nuget.md
 	EndProjectSection
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "jcdcdev.Umbraco.Core", "jcdcdev.Umbraco.Core\jcdcdev.Umbraco.Core.csproj", "{EC825C30-A30B-4ABF-AD64-FCA92C9EA75C}"

diff --git a/src/jcdcdev.Umbraco.Core/jcdcdev.Umbraco.Core.csproj b/src/jcdcdev.Umbraco.Core/jcdcdev.Umbraco.Core.csproj
@@ -16,7 +16,7 @@
         <Copyright>$([System.DateTime]::UtcNow.ToString(`yyyy`)) © James Carter</Copyright>
         <PackageProjectUrl>https://jcdc.dev/umbraco-packages/core</PackageProjectUrl>
         <RepositoryUrl>https://github.com/jcdcdev/jcdcdev.Umbraco.Core</RepositoryUrl>
-        <PackageReadmeFile>README.md</PackageReadmeFile>
+        <PackageReadmeFile>README_nuget.md</PackageReadmeFile>
         <RepositoryType>git</RepositoryType>
         <PackageLicenseExpression>MIT</PackageLicenseExpression>
         <PackageIcon>images\icon.png</PackageIcon>
@@ -38,6 +38,6 @@
 
     <ItemGroup>
         <None Include="..\..\docs\icon.png" Pack="true" PackagePath="images\icon.png"/>
-        <None Include="..\..\.github\README.md" Pack="true" PackagePath="\"/>
+        <None Include="..\..\docs\README_nuget.md" Pack="true" PackagePath="\"/>
     </ItemGroup>
 </Project>