|
1 | | -# jcdcdev.Umbraco.PackageTemplate |
| 1 | +# Package Template |
2 | 2 |
|
3 | 3 | [](https://docs.jcdc.dev/jcdcdev-umbraco-packagetemplate/latest) |
4 | 4 | [](https://github.com/jcdcdev/jcdcdev.Umbraco.PackageTemplate) |
|
8 | 8 |
|
9 | 9 | An opinionated template for creating Umbraco packages hosted on GitHub. |
10 | 10 |
|
11 | | -## Installation |
| 11 | +## Security |
12 | 12 |
|
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. |
70 | 15 |
|
71 | 16 | ## Contributing |
72 | 17 |
|
|
0 commit comments