From 756f835e7809daf8ca456f6d71ed287764c84809 Mon Sep 17 00:00:00 2001 From: jcdcdev <23620443+jcdcdev@users.noreply.github.com> Date: Thu, 29 Jan 2026 01:11:47 +0000 Subject: [PATCH 1/2] doc: Update README --- .github/README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/.github/README.md b/.github/README.md index 18c585e..89c5110 100644 --- a/.github/README.md +++ b/.github/README.md @@ -1,5 +1,6 @@ -# Umbraco.Community.SimpleDashboards +# Simple Dashboards +[![Documentation](https://img.shields.io/badge/Documentation-123?color=394933&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxNiIgaGVpZ2h0PSIxNiIgZmlsbD0iY3VycmVudENvbG9yIiBjb2xvcj0id2hpdGUiIGNsYXNzPSJiaSBiaS1ib29rIiB2aWV3Qm94PSIwIDAgMTYgMTYiPgogIDxwYXRoIGQ9Ik0xIDIuODI4Yy44ODUtLjM3IDIuMTU0LS43NjkgMy4zODgtLjg5MyAxLjMzLS4xMzQgMi40NTguMDYzIDMuMTEyLjc1MnY5Ljc0NmMtLjkzNS0uNTMtMi4xMi0uNjAzLTMuMjEzLS40OTMtMS4xOC4xMi0yLjM3LjQ2MS0zLjI4Ny44MTF6bTcuNS0uMTQxYy42NTQtLjY4OSAxLjc4Mi0uODg2IDMuMTEyLS43NTIgMS4yMzQuMTI0IDIuNTAzLjUyMyAzLjM4OC44OTN2OS45MjNjLS45MTgtLjM1LTIuMTA3LS42OTItMy4yODctLjgxLTEuMDk0LS4xMTEtMi4yNzgtLjAzOS0zLjIxMy40OTJ6TTggMS43ODNDNy4wMTUuOTM2IDUuNTg3LjgxIDQuMjg3Ljk0Yy0xLjUxNC4xNTMtMy4wNDIuNjcyLTMuOTk0IDEuMTA1QS41LjUgMCAwIDAgMCAyLjV2MTFhLjUuNSAwIDAgMCAuNzA3LjQ1NWMuODgyLS40IDIuMzAzLS44ODEgMy42OC0xLjAyIDEuNDA5LS4xNDIgMi41OS4wODcgMy4yMjMuODc3YS41LjUgMCAwIDAgLjc4IDBjLjYzMy0uNzkgMS44MTQtMS4wMTkgMy4yMjItLjg3NyAxLjM3OC4xMzkgMi44LjYyIDMuNjgxIDEuMDJBLjUuNSAwIDAgMCAxNiAxMy41di0xMWEuNS41IDAgMCAwLS4yOTMtLjQ1NWMtLjk1Mi0uNDMzLTIuNDgtLjk1Mi0zLjk5NC0xLjEwNUMxMC40MTMuODA5IDguOTg1LjkzNiA4IDEuNzgzIi8+Cjwvc3ZnPg==)](#https://docs.jcdc.dev/umbraco-community-simpledashboards/latest) [![Umbraco Marketplace](https://img.shields.io/badge/Umbraco%20Marketplace-%23f5c1bc?logo=umbraco&logoColor=162335)](https://marketplace.umbraco.com/package/Umbraco.Community.SimpleDashboards) [![GitHub](https://img.shields.io/badge/GitHub-1?logo=github&color=232925)](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards) [![NuGet Downloads](https://img.shields.io/nuget/dt/Umbraco.Community.SimpleDashboards?labelColor=4536d3&color=4536d3&label=NuGet&logo=nuget)](https://www.nuget.org/packages/Umbraco.Community.SimpleDashboards) @@ -20,11 +21,21 @@ This packages aims to help developers quickly put together Umbraco Dashboards us > Please review the [security policy](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards?tab=security-ov-file#supported-versions) for more information. +## Security + +> [!NOTE] +> This project takes security and support seriously. +> Please visit the [Security](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards?tab=security-ov-file) page for more information. + + + ## Contributing Contributions to this package are most welcome! Please visit the [Contributing](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/contribute) page. -## Acknowledgements (Thanks) +## Acknowledgements + +Thank you to the following projects and individuals for their contributions. High five, you rock! 🤘🦄 - LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter) From 7d076d34938a3bf9bab9677c9e43e66524b7895e Mon Sep 17 00:00:00 2001 From: jcdcdev <23620443+jcdcdev@users.noreply.github.com> Date: Thu, 29 Jan 2026 01:11:49 +0000 Subject: [PATCH 2/2] doc: Update NuGet README --- docs/README_nuget.md | 44 +++++++------------------------------------- 1 file changed, 7 insertions(+), 37 deletions(-) diff --git a/docs/README_nuget.md b/docs/README_nuget.md index 895419b..edd11fd 100644 --- a/docs/README_nuget.md +++ b/docs/README_nuget.md @@ -1,4 +1,4 @@ -# Umbraco.Community.SimpleDashboards +# Simple Dashboards [![Documentation](https://img.shields.io/badge/Documentation-123?color=394933&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxNiIgaGVpZ2h0PSIxNiIgZmlsbD0iY3VycmVudENvbG9yIiBjb2xvcj0id2hpdGUiIGNsYXNzPSJiaSBiaS1ib29rIiB2aWV3Qm94PSIwIDAgMTYgMTYiPgogIDxwYXRoIGQ9Ik0xIDIuODI4Yy44ODUtLjM3IDIuMTU0LS43NjkgMy4zODgtLjg5MyAxLjMzLS4xMzQgMi40NTguMDYzIDMuMTEyLjc1MnY5Ljc0NmMtLjkzNS0uNTMtMi4xMi0uNjAzLTMuMjEzLS40OTMtMS4xOC4xMi0yLjM3LjQ2MS0zLjI4Ny44MTF6bTcuNS0uMTQxYy42NTQtLjY4OSAxLjc4Mi0uODg2IDMuMTEyLS43NTIgMS4yMzQuMTI0IDIuNTAzLjUyMyAzLjM4OC44OTN2OS45MjNjLS45MTgtLjM1LTIuMTA3LS42OTItMy4yODctLjgxLTEuMDk0LS4xMTEtMi4yNzgtLjAzOS0zLjIxMy40OTJ6TTggMS43ODNDNy4wMTUuOTM2IDUuNTg3LjgxIDQuMjg3Ljk0Yy0xLjUxNC4xNTMtMy4wNDIuNjcyLTMuOTk0IDEuMTA1QS41LjUgMCAwIDAgMCAyLjV2MTFhLjUuNSAwIDAgMCAuNzA3LjQ1NWMuODgyLS40IDIuMzAzLS44ODEgMy42OC0xLjAyIDEuNDA5LS4xNDIgMi41OS4wODcgMy4yMjMuODc3YS41LjUgMCAwIDAgLjc4IDBjLjYzMy0uNzkgMS44MTQtMS4wMTkgMy4yMjItLjg3NyAxLjM3OC4xMzkgMi44LjYyIDMuNjgxIDEuMDJBLjUuNSAwIDAgMCAxNiAxMy41di0xMWEuNS41IDAgMCAwLS4yOTMtLjQ1NWMtLjk1Mi0uNDMzLTIuNDgtLjk1Mi0zLjk5NC0xLjEwNUMxMC40MTMuODA5IDguOTg1LjkzNiA4IDEuNzgzIi8+Cjwvc3ZnPg==)](#https://docs.jcdc.dev/umbraco-community-simpledashboards/latest) [![Umbraco Marketplace](https://img.shields.io/badge/Umbraco%20Marketplace-%23f5c1bc?logo=umbraco&logoColor=162335)](https://marketplace.umbraco.com/package/Umbraco.Community.SimpleDashboards) @@ -16,48 +16,18 @@ This packages aims to help developers quickly put together Umbraco Dashboards us - Supports both Views & View Components - Easy to define section permissions -## Installation +## Security -### Install Package - -```powershell -dotnet add package Umbraco.Community.SimpleDashboards -``` - -## Quick Start - -### Register Dashboard - -By default, this will display in the content section for Admins only. - -```csharp title="BasicDashboard.cs" -using Umbraco.Community.SimpleDashboards.Web; -public class BasicDashboard : SimpleDashboard { } -``` - -### Create View - -- Your view **must** go in `/Views/Dashboard` -- You view **must** be the name of your C# class (without `Dashboard`) - - For example: `BasicDashboard.cs` => `/Views/Dashboard/Basic.cshtml` - -```csharp title="Views/Dashboard/Basic.cshtml" -@inherits Umbraco.Community.SimpleDashboards.Web.DashboardViewPage - - -

My Dashboard is: @Model.Dashboard.Alias

- -``` - -### More Examples - -[docs/examples.md](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/blob/v15/docs/examples.md) +This project takes security and support seriously. +Please visit the [Security](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards?tab=security-ov-file) page for more information. ## Contributing Contributions to this package are most welcome! Please visit the [Contributing](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/contribute) page. -## Acknowledgements (Thanks) +## Acknowledgements + +Thank you to the following projects and individuals for their contributions. High five, you rock! 🤘🦄 - LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter)