diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 89a4a1d..677d229 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -5,7 +5,7 @@ on: release: types: [published] jobs: - build: + publish: # 2019, has our .NET needs, latest does not runs-on: windows-2019 steps: diff --git a/README.md b/README.md index 8a31e0f..0ef84c4 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,16 @@ # Elements.Quantity -Handful .NET library for working with various physical quantities, including conversions, formatting and parsing +Handful .NET library for working with various physical quantities, including conversions, formatting and parsing. + +![NuGet](https://img.shields.io/nuget/v/YellowDogMan.Elements.Quantity.svg) + +## Building +This library should be build-able using a standard Visual Studio setup. As there are no dependencies, it is usually quite fast. + +## Publishing a New Nuget Version + +Version releases are handled automatically by GitHub Actions. You do need to trigger a release though. To do this: +1. Git Tag a git commit with the new version number. Tags must be in the format: `version number` without any prefixes or suffixes. E.g.`1.0.0` +1. Push that Tag to Github however you'd like e.g. `git push --tags` +1. [Draft a new GitHub Release](https://github.com/Yellow-Dog-Man/Elements.Quantity/releases/new) using that tag in the "Choose a tag" drop down. +1. Write suitable release notes, If PRs were used the "Generate release notes" button will automatically populate them. +1. Publish the release.