Skip to content

Commit 15bd1f3

Browse files
committed
doc: Update NuGet README
1 parent 1b5be8a commit 15bd1f3

File tree

1 file changed

+4
-59
lines changed

1 file changed

+4
-59
lines changed

docs/README_nuget.md

Lines changed: 4 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# jcdcdev.Umbraco.PackageTemplate
1+
# Package Template
22

33
[![Documentation](https://img.shields.io/badge/Documentation-123?color=394933&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxNiIgaGVpZ2h0PSIxNiIgZmlsbD0iY3VycmVudENvbG9yIiBjb2xvcj0id2hpdGUiIGNsYXNzPSJiaSBiaS1ib29rIiB2aWV3Qm94PSIwIDAgMTYgMTYiPgogIDxwYXRoIGQ9Ik0xIDIuODI4Yy44ODUtLjM3IDIuMTU0LS43NjkgMy4zODgtLjg5MyAxLjMzLS4xMzQgMi40NTguMDYzIDMuMTEyLjc1MnY5Ljc0NmMtLjkzNS0uNTMtMi4xMi0uNjAzLTMuMjEzLS40OTMtMS4xOC4xMi0yLjM3LjQ2MS0zLjI4Ny44MTF6bTcuNS0uMTQxYy42NTQtLjY4OSAxLjc4Mi0uODg2IDMuMTEyLS43NTIgMS4yMzQuMTI0IDIuNTAzLjUyMyAzLjM4OC44OTN2OS45MjNjLS45MTgtLjM1LTIuMTA3LS42OTItMy4yODctLjgxLTEuMDk0LS4xMTEtMi4yNzgtLjAzOS0zLjIxMy40OTJ6TTggMS43ODNDNy4wMTUuOTM2IDUuNTg3LjgxIDQuMjg3Ljk0Yy0xLjUxNC4xNTMtMy4wNDIuNjcyLTMuOTk0IDEuMTA1QS41LjUgMCAwIDAgMCAyLjV2MTFhLjUuNSAwIDAgMCAuNzA3LjQ1NWMuODgyLS40IDIuMzAzLS44ODEgMy42OC0xLjAyIDEuNDA5LS4xNDIgMi41OS4wODcgMy4yMjMuODc3YS41LjUgMCAwIDAgLjc4IDBjLjYzMy0uNzkgMS44MTQtMS4wMTkgMy4yMjItLjg3NyAxLjM3OC4xMzkgMi44LjYyIDMuNjgxIDEuMDJBLjUuNSAwIDAgMCAxNiAxMy41di0xMWEuNS41IDAgMCAwLS4yOTMtLjQ1NWMtLjk1Mi0uNDMzLTIuNDgtLjk1Mi0zLjk5NC0xLjEwNUMxMC40MTMuODA5IDguOTg1LjkzNiA4IDEuNzgzIi8+Cjwvc3ZnPg==)](https://docs.jcdc.dev/jcdcdev-umbraco-packagetemplate/latest)
44
[![GitHub](https://img.shields.io/badge/GitHub-1?logo=github&color=232925)](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate)
@@ -8,65 +8,10 @@
88

99
An opinionated template for creating Umbraco packages hosted on GitHub.
1010

11-
## Installation
11+
## Security
1212

13-
### Install Package
14-
```powershell
15-
dotnet add package jcdcdev.Umbraco.PackageTemplate
16-
```
17-
18-
## Quick Start
19-
20-
### Prerequisites
21-
22-
1. A basic understanding of NuGet package development
23-
- A NuGet API key - [Create an API key](https://learn.microsoft.com/en-us/nuget/nuget-org/publish-a-package)
24-
2. A git repository on GitHub
25-
- Your repository name must match the project name e.g. `Demo.Package`
26-
- [GitHub Action Secret](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions) - `NUGET_API_KEY`
27-
with your NuGet API key
28-
29-
3. Install template
30-
31-
### Create package
32-
33-
1. Create new project
34-
35-
#### dotnet CLI
36-
37-
```powershell
38-
dotnet new jcdcdev-umb-package -o Demo.Package --ghUsername jcdcdev --title "My Demo Package" --description "An empty Umbraco package" --addClient
39-
```
40-
41-
#### Visual Studio
42-
- Open Visual Studio
43-
- Create a new project
44-
- Search for `jcdcdev-umb-package`
45-
- Click `Next`
46-
- Fill in the project title, description, and other details
47-
- Click `Create`
48-
49-
2. Open project in your IDE
50-
3. Build and run project
51-
4. Congratulations! You have created an empty Umbraco package 🎉
52-
53-
Now you can implement your package features.
54-
55-
1. Update `README.md` with your package details
56-
2. Update `umbraco-marketplace.json` with your package details
57-
58-
### Publish
59-
60-
1. Push your code to GitHub
61-
2. Create a pull request into the `main` branch
62-
3. Merge the pull request
63-
4. A new release will be created
64-
65-
## Configuration
66-
67-
## Template Parameters
68-
69-
[Documentation](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate?tab=readme-ov-file#template-parameters)
13+
This project takes security and support seriously.
14+
Please visit the [Security](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate?tab=security-ov-file) page for more information.
7015

7116
## Contributing
7217

0 commit comments

Comments
 (0)