Skip to content

Commit 728846f

Browse files
committed
doc: Update README
1 parent bb34e9f commit 728846f

File tree

1 file changed

+5
-63
lines changed

1 file changed

+5
-63
lines changed

.github/README.md

Lines changed: 5 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,18 @@
11
# Umbraco.Community.SimpleContentApps
22

3-
[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco-Marketplace-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/umbraco.community.simplecontentapps)
4-
[![GitHub License](https://img.shields.io/github/license/jcdcdev/Umbraco.Community.SimpleContentApps?color=8AB803&label=License&logo=github)](https://github.com/jcdcdev/Umbraco.Community.SimpleContentApps/blob/main/LICENSE)
5-
[![NuGet Downloads](https://img.shields.io/nuget/dt/Umbraco.Community.SimpleContentApps?color=cc9900&label=Downloads&logo=nuget)](https://www.nuget.org/packages/Umbraco.Community.SimpleContentApps/)
3+
[![Umbraco Marketplace](https://img.shields.io/badge/Umbraco-Marketplace-%233544B1?style=flat&logo=umbraco)](https://marketplace.umbraco.com/package/Umbraco.Community.SimpleContentApps)
4+
[![License](https://img.shields.io/github/license/jcdcdev/Umbraco.Community.SimpleContentApps?color=8AB803&label=License&logo=github)](https://github.com/jcdcdev/Umbraco.Community.SimpleContentApps?tab=MIT-1-ov-file)
5+
[![NuGet Downloads](https://img.shields.io/nuget/dt/Umbraco.Community.SimpleContentApps?color=cc9900&label=Downloads&logo=nuget)](https://www.nuget.org/packages/Umbraco.Community.SimpleContentApps)
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-content-apps)
77

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

10-
Looking for Umbraco 14+ Content Apps? Check out [Umbraco.Community.SimpleWorkspaceViews](https://github.com/jcdcdev/Umbraco.Community.SimpleWorkspaceViews)
119

12-
![Basic ContentApp in the Umbraco Office](https://raw.githubusercontent.com/jcdcdev/Umbraco.Community.SimpleContentApps/main/docs/screenshot.png)
1310

14-
## Features
15-
- Simplifies C# based ContentApp creation
16-
- Supports both Views & View Components
17-
- No package.manifest or lang/lang.xml files required!
18-
- Variant support (culture specific names)
19-
- Easy to define Access Rules
2011

21-
## Quick Start
22-
23-
### Install Package
24-
```csharp
25-
dotnet add package Umbraco.Community.SimpleContentApps
26-
```
27-
28-
### Register ContentApp
29-
30-
```csharp
31-
using Umbraco.Cms.Core.Dashboards;
32-
using Umbraco.Cms.Core.Models.ContentEditing;
33-
using Umbraco.Community.SimpleContentApps.Core;
34-
35-
namespace Umbraco.Community.SimpleContentApps.TestSite;
36-
37-
public class BasicContentApp : ISimpleContentApp
38-
{
39-
public string Icon => Cms.Core.Constants.Icons.Content;
40-
public bool ShowInContent => true;
41-
public bool ShowInContentType => false;
42-
public bool ShowInMedia => false;
43-
public bool ShowInMembers => false;
44-
public IAccessRule[] Rules => new[] { SimpleAccessRule.AllowAdminGroup };
45-
public int Weight => 0;
46-
public string Name => "Basic Content App";
47-
public string? CultureName(string? currentUiCulture) => Name;
48-
public ContentAppBadge? Badge => ContentAppBadges.None;
49-
}
50-
```
51-
52-
### Create View
53-
54-
- Your view **must** go in `/Views/ContentApps`
55-
- You view **must** be the name of your C# class (without `ContentApp`)
56-
- For example: `BasicContentApp.cs` => `/Views/ContentApps/Basic.cshtml`
57-
58-
```csharp
59-
@using Umbraco.Community.SimpleContentApps.Core.Extensions
60-
@inherits Umbraco.Community.SimpleContentApps.Web.SimpleContentAppViewPage
61-
62-
<h1>Hello Umbraco</h1>
63-
<p>My ContentApp alias is: @Model.ContentApp.Alias()</p>
64-
```
65-
66-
### More Examples
67-
68-
[docs/examples.md](https://github.com/jcdcdev/Umbraco.Community.SimpleContentApps/blob/dev/docs/examples.md)
6912

7013
## Contributing
7114

72-
Contributions to this package are most welcome! Please read the [Contributing Guidelines](https://github.com/jcdcdev/Umbraco.Community.SimpleContentApps/blob/main/.github/CONTRIBUTING.md).
15+
Contributions to this package are most welcome! Please visit the [Contributing](https://github.com/jcdcdev/Umbraco.Community.SimpleContentApps/contribute) page.
16+
7317

74-
## Acknowledgments (thanks!)
7518

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

0 commit comments

Comments
 (0)