Skip to content

Commit 58df23f

Browse files
committed
doc: Update NuGet README
1 parent a8c0c1c commit 58df23f

File tree

1 file changed

+54
-10
lines changed

1 file changed

+54
-10
lines changed

docs/README_nuget.md

Lines changed: 54 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,64 @@
11
# Umbraco.Community.SimpleDashboards
22

3-
[![Documentation](https://img.shields.io/badge/Docs-Quickstart-394933?style=flat&logo=github)](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/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/umbraco.community.simpledashboards)
5-
[![GitHub License](https://img.shields.io/github/license/jcdcdev/Umbraco.Community.SimpleDashboards?color=8AB803&label=License&logo=github)](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/blob/v14/LICENSE)
6-
[![NuGet Downloads](https://img.shields.io/nuget/dt/Umbraco.Community.SimpleDashboards?color=cc9900&label=Downloads&logo=nuget)](https://www.nuget.org/packages/Umbraco.Community.SimpleDashboards/)
3+
[![Documentation](https://img.shields.io/badge/Docs-Quickstart-394933?style=flat&logo=github)](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards#quick-start)
4+
[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco-Marketplace-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/Umbraco.Community.SimpleDashboards)
5+
[![License](https://img.shields.io/github/license/jcdcdev/Umbraco.Community.SimpleDashboards?color=8AB803&label=License&logo=github)](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards?tab=MIT-1-ov-file)
6+
[![NuGet Downloads](https://img.shields.io/nuget/dt/Umbraco.Community.SimpleDashboards?color=cc9900&label=Downloads&logo=nuget)](https://www.nuget.org/packages/Umbraco.Community.SimpleDashboards)
77
[![Project Website](https://img.shields.io/badge/Project%20Website-jcdc.dev-jcdcdev?style=flat&color=3c4834&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxNiIgaGVpZ2h0PSIxNiIgZmlsbD0id2hpdGUiIGNsYXNzPSJiaSBiaS1wYy1kaXNwbGF5IiB2aWV3Qm94PSIwIDAgMTYgMTYiPgogIDxwYXRoIGQ9Ik04IDFhMSAxIDAgMCAxIDEtMWg2YTEgMSAwIDAgMSAxIDF2MTRhMSAxIDAgMCAxLTEgMUg5YTEgMSAwIDAgMS0xLTF6bTEgMTMuNWEuNS41IDAgMSAwIDEgMCAuNS41IDAgMCAwLTEgMG0yIDBhLjUuNSAwIDEgMCAxIDAgLjUuNSAwIDAgMC0xIDBNOS41IDFhLjUuNSAwIDAgMCAwIDFoNWEuNS41IDAgMCAwIDAtMXpNOSAzLjVhLjUuNSAwIDAgMCAuNS41aDVhLjUuNSAwIDAgMCAwLTFoLTVhLjUuNSAwIDAgMC0uNS41TTEuNSAyQTEuNSAxLjUgMCAwIDAgMCAzLjV2N0ExLjUgMS41IDAgMCAwIDEuNSAxMkg2djJoLS41YS41LjUgMCAwIDAgMCAxSDd2LTRIMS41YS41LjUgMCAwIDEtLjUtLjV2LTdhLjUuNSAwIDAgMSAuNS0uNUg3VjJ6Ii8+Cjwvc3ZnPg==)](https://jcdc.dev/umbraco-packages/simple-dashboards)
88

9-
This packages aims to help developers quickly put together Umbraco Dashboards using C# only.
109

11-
![Basic Dashboard in the Umbraco Office](https://raw.githubusercontent.com/jcdcdev/Umbraco.Community.SimpleDashboards/v14/docs/screenshot.png)
10+
This packages aims to help developers quickly put together Umbraco Dashboards using C#.
11+
12+
## Features
13+
14+
- C# dashboard creation
15+
- No javascript or umbraco-package.json files required
16+
- Supports both Views & View Components
17+
- Easy to define section permissions
18+
19+
## Quick Start
20+
21+
### Install Package
22+
23+
```csharp
24+
dotnet add package Umbraco.Community.SimpleDashboards
25+
```
26+
27+
### Register Dashboard
28+
29+
By default, this will display in the content section for Admins only.
30+
31+
```csharp title="BasicDashboard.cs"
32+
using Umbraco.Community.SimpleDashboards.Web;
33+
public class BasicDashboard : SimpleDashboard { }
34+
```
35+
36+
### Create View
37+
38+
- Your view **must** go in `/Views/Dashboard`
39+
- You view **must** be the name of your C# class (without `Dashboard`)
40+
- For example: `BasicDashboard.cs` => `/Views/Dashboard/Basic.cshtml`
41+
42+
```csharp title="Views/Dashboard/Basic.cshtml"
43+
@inherits Umbraco.Community.SimpleDashboards.Web.DashboardViewPage
44+
45+
<uui-box headline="Hello Umbraco">
46+
<p>My Dashboard is: @Model.Dashboard.Alias</p>
47+
</uui-box>
48+
```
49+
50+
### More Examples
51+
52+
[docs/examples.md](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/blob/v15/docs/examples.md)
53+
1254

1355
## Contributing
1456

15-
Contributions to this package are most welcome! Please read
16-
the [Contributing Guidelines](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/blob/v14/.github/CONTRIBUTING.md).
57+
Contributions to this package are most welcome! Please visit the [Contributing](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/contribute) page.
58+
59+
## Acknowledgements (Thanks)
60+
61+
- LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter)
62+
1763

18-
## Acknowledgments (thanks!)
1964

20-
- LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter)

0 commit comments

Comments
 (0)