Skip to content

Commit a8c0c1c

Browse files
committed
doc: Update README
1 parent cabf797 commit a8c0c1c

File tree

1 file changed

+46
-43
lines changed

1 file changed

+46
-43
lines changed

.github/README.md

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

3-
[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco-Marketplace-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/umbraco.community.simpledashboards)
4-
[![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)
5-
[![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+
[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco-Marketplace-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/Umbraco.Community.SimpleDashboards)
4+
[![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)
5+
[![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)
66
[![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)
77

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

10-
![Basic Dashboard in the Umbraco Office](https://raw.githubusercontent.com/jcdcdev/Umbraco.Community.SimpleDashboards/v14/docs/screenshot.png)
11-
12-
## Features
13-
14-
- C# dashboard creation
15-
- No javascript or umbraco-package.json files required
16-
- Supports both Views & View Components
9+
This packages aims to help developers quickly put together Umbraco Dashboards using C#.
10+
11+
## Features
12+
13+
- C# dashboard creation
14+
- No javascript or umbraco-package.json files required
15+
- Supports both Views & View Components
1716
- Easy to define section permissions
1817

1918
## Quick Start
2019

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.
20+
### Install Package
21+
22+
```csharp
23+
dotnet add package Umbraco.Community.SimpleDashboards
24+
```
25+
26+
### Register Dashboard
27+
28+
By default, this will display in the content section for Admins only.
29+
30+
```csharp title="BasicDashboard.cs"
31+
using Umbraco.Community.SimpleDashboards.Web;
32+
public class BasicDashboard : SimpleDashboard { }
33+
```
34+
35+
### Create View
36+
37+
- Your view **must** go in `/Views/Dashboard`
38+
- You view **must** be the name of your C# class (without `Dashboard`)
39+
- For example: `BasicDashboard.cs` => `/Views/Dashboard/Basic.cshtml`
40+
41+
```csharp title="Views/Dashboard/Basic.cshtml"
42+
@inherits Umbraco.Community.SimpleDashboards.Web.DashboardViewPage
43+
44+
<uui-box headline="Hello Umbraco">
45+
<p>My Dashboard is: @Model.Dashboard.Alias</p>
46+
</uui-box>
47+
```
48+
49+
### More Examples
50+
51+
[docs/examples.md](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/blob/v15/docs/examples.md)
3052
31-
```csharp
32-
using Umbraco.Community.SimpleDashboards.Web;
33-
public class BasicDashboard : SimpleDashboard { }
34-
```
3553

36-
### Create View
3754

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
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-
```
55+
## Contributing
4956

50-
### More Examples
57+
Contributions to this package are most welcome! Please visit the [Contributing](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/contribute) page.
5158
52-
[docs/examples.md](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/blob/v14/docs/examples.md)
59+
## Acknowledgements (Thanks)
5360

54-
## Contributing
61+
- LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter)
5562
56-
Contributions to this package are most welcome! Please read
57-
the [Contributing Guidelines](https://github.com/jcdcdev/Umbraco.Community.SimpleDashboards/blob/v14/.github/CONTRIBUTING.md).
5863

59-
## Acknowledgments (thanks!)
6064

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

0 commit comments

Comments
 (0)