Skip to content

Commit c3618f7

Browse files
authored
Update README.md
1 parent 9dd7fbb commit c3618f7

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
![GitHub License](https://img.shields.io/github/license/codeaphex/github_release_nuget_workflow?logo=github)
55
![Nuget Downloads](https://img.shields.io/nuget/dt/github_release_nuget_workflow?logo=nuget)
66

7+
## Status
8+
79
### Workflow
810

911
[![Workflow Badge](https://github.com/codeaphex/github_release_nuget_workflow/workflows/Generate%20NuGet%20package/badge.svg)](https://github.com/codeaphex/github_release_nuget_workflow/blob/master/.github/workflows/release_nuget_workflow.yaml)
@@ -18,8 +20,14 @@
1820
![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/codeaphex/github_release_nuget_workflow?include_prereleases&label=dev%20release&sort=semver&logo=github)
1921
![Nuget (with prereleases)](https://img.shields.io/nuget/vpre/github_release_nuget_workflow?label=dev%20nuget&logo=nuget)
2022

23+
## Features
24+
25+
- Create and push a NuGet package on a Github Release
26+
- Supports Semantic Versioning 2.0.0 for prerelease packages
27+
28+
## Usage
2129

22-
## Prerequisites
30+
### Prerequisites
2331

2432
- GitHub project secret named NUGET_TOKEN with a valid NuGet API key is set
2533
- AssemblyVersion of the library matches the GitHub Release version tag
@@ -31,8 +39,11 @@
3139
**0.1.1-alpha**
3240
**v0.1.1-beta.2**
3341

34-
## Features
35-
36-
- Create and push a NuGet package on a Github Release
37-
- Supports Semantic Versioning 2.0.0 for prerelease packages
42+
### Getting started
3843

44+
1. Copy workflow
45+
1. Set secret
46+
1. Check Assembly version
47+
1. Push
48+
1. Create release
49+
1. Profit!!!

0 commit comments

Comments
 (0)