Skip to content

Commit

Permalink
docs(readme): some instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
ProbablePrime committed Oct 28, 2023
1 parent c782687 commit f3abb4b
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ on:
release:
types: [published]
jobs:
build:
publish:
# 2019, has our .NET needs, latest does not
runs-on: windows-2019
steps:
Expand Down
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit f3abb4b

Please sign in to comment.