docs: add notes on publishing

podimo · Oct 24, 2024 · 84737e7 · 84737e7
1 parent 5f90e48
commit 84737e7
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -7,6 +7,12 @@ This project is a [Source Generator](https://docs.microsoft.com/en-us/dotnet/csh
 We use project files to control the generation of constants.
 You can see how these are used in [Podimo.ExampleConsoleApp](examples/Podimo.ExampleConsoleApp/Podimo.ExampleConsoleApp.csproj).
 
+## Publish to Nuget
+
+Publishing to Nuget requires a tag to be attached to a given commit in the `main` branch.
+GitHub Actions will build the package, publish to Nuget and create a GitHub release as well.
+
+
 ## License
 
 See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT).