Skip to content

Commit 3af9608

Browse files
committed
doc: README
1 parent ae560e5 commit 3af9608

File tree

1 file changed

+30
-3
lines changed

1 file changed

+30
-3
lines changed

.github/README.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,41 @@
22

33
[![Umbraco Version](https://img.shields.io/badge/Umbraco-10.4+-%233544B1?style=flat&logo=umbraco)](https://umbraco.com/products/umbraco-cms/)
44
[![NuGet](https://img.shields.io/nuget/vpre/Umbraco.Community.DataProtection?color=0273B3)](https://www.nuget.org/packages/Umbraco.Community.DataProtection)
5-
[![GitHub license](https://img.shields.io/github/license/jcdcdev/Umbraco.Community.DataProtection?color=8AB803)](../LICENSE)
5+
[![GitHub license](https://img.shields.io/github/license/jcdcdev/Umbraco.Community.DataProtection?color=8AB803)](https://github.com/jcdcdev/Umbraco.Community.DataProtection/LICENSE)
66
[![Downloads](https://img.shields.io/nuget/dt/Umbraco.Community.DataProtection?color=cc9900)](https://www.nuget.org/packages/Umbraco.Community.DataProtection/)
77

8+
Zero config [ASP.NET Core Data Protection](https://learn.microsoft.com/en-us/aspnet/core/security/data-protection/introduction?view=aspnetcore-8.0) for Umbraco CMS.
9+
10+
Data protection keys are stored in the Umbraco database.
11+
12+
## Quick Start
13+
14+
### Install
15+
```csharp
16+
dotnet add package Umbraco.Community.DataProtection
17+
```
18+
19+
### Configure
20+
```csharp
21+
using Umbraco.Cms.Core.Composing;
22+
using Umbraco.Cms.Core.DependencyInjection;
23+
24+
namespace Project.Web;
25+
26+
public class Composer : IComposer
27+
{
28+
public void Compose(IUmbracoBuilder builder)
29+
{
30+
builder.AddUmbracoDataProtection();
31+
}
32+
}
33+
```
34+
835
## Contributing
936

10-
Contributions to this package are most welcome! Please read the [Contributing Guidelines](CONTRIBUTING.md).
37+
Contributions to this package are most welcome! Please read the [Contributing Guidelines](https://github.com/jcdcdev/Umbraco.Community.DataProtection/blob/main/.github/CONTRIBUTING.md).
1138

1239
## Acknowledgments (thanks!)
1340

1441
- LottePitcher - [opinionated-package-starter](https://github.com/LottePitcher/opinionated-package-starter)
15-
- jcdcdev - [jcdcdev.Umbraco.PackageTemplate](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate)
42+
- jcdcdev - [jcdcdev.Umbraco.PackageTemplate](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate)

0 commit comments

Comments
 (0)