docs: added generated output docs

Author: kieronlanning

.vscode/extensions.json

@@ -1,7 +1,12 @@
 {
-    "recommendations": [
-        "ms-dotnettools.csdevkit",
-        "github.vscode-github-actions",
-        "github.vscode-pull-request-github"
-    ]
-}
+	"recommendations": [
+		"ms-dotnettools.csdevkit",
+		"github.vscode-github-actions",
+		"github.vscode-pull-request-github",
+		"streetsidesoftware.code-spell-checker",
+		"bierner.github-markdown-preview",
+		"davidanson.vscode-markdownlint",
+		"pkief.material-icon-theme",
+		"esbenp.prettier-vscode"
+	]
+}

Makefile

@@ -6,7 +6,7 @@ SOLUTION_FILE = $(ROOT_FOLDER)Purview.Telemetry.SourceGenerator.sln
 TEST_PROJECT = $(ROOT_FOLDER)Purview.Telemetry.SourceGenerator.sln
 CONFIGURATION = Release
 
-PACK_VERSION = 2.0.0
+PACK_VERSION := $(shell bun -e 'console.log(require("./package.json").version)')
 ARTIFACT_FOLDER = p:/sync-projects/.local-nuget/
 
 # Common variables
@@ -46,8 +46,11 @@ act:
 
 vs: ## Opens the project in Visual Studio.
 	@echo -e "Opening $(COLOUR_BLUE)$(SOLUTION_FILE)$(COLOUR_RESET) in $(COLOUR_ORANGE)Visual Studio$(COLOUR_RESET)..."
-	@start $(SOLUTION_FILE)
+	@start "$(SOLUTION_FILE)"
 
 code: ## Opens the project in Visual Studio Code.
 	@echo -e "Opening $(COLOUR_BLUE)Visual Studio Code$(COLOUR_RESET)..."
 	@code .
+
+version: ## Displays the current version of the project.
+	@echo -e "Current Version: $(COLOUR_GREEN)$(PACK_VERSION)$(COLOUR_RESET)"

README.md

@@ -4,15 +4,15 @@ Generates [ActivitySource](https://learn.microsoft.com/en-us/dotnet/api/system.d
 
 The latest version is available on [NuGet](https://www.nuget.org/packages/Purview.Telemetry.SourceGenerator/), and supports generation for the following frameworks:
 
-* .NET Framework 4.7.2
-* .NET Framework 4.8
-* .NET 8
-* .NET 9
+- .NET Framework 4.7.2
+- .NET Framework 4.8
+- .NET 8
+- .NET 9
 
 Reference in your `Directory.Build.props` or `.csproj` file:
 
 ```xml
-<PackageReference Include="Purview.Telemetry.SourceGenerator" Version="2.0.0">
+<PackageReference Include="Purview.Telemetry.SourceGenerator" Version="2.0.1">
   <PrivateAssets>all</PrivateAssets>
   <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
 </PackageReference>
@@ -70,7 +70,9 @@ interface IEntityStoreTelemetry
 
 For more information see the [wiki](https://github.com/purview-dev/purview-telemetry-sourcegenerator/wiki).
 
-> To see the generated output for the above, sett the [`Generated Output`](https://github.com/purview-dev/purview-telemetry-sourcegenerator/wiki/Generated-Output) page in the wiki.
+> To see the generated output for the above, see the [`Generated Output`](https://github.com/purview-dev/purview-telemetry-sourcegenerator/wiki/Generated-Output) page in the wiki.
+
+## Example Project
 
 Checkout the [.NET Aspire Sample](https://github.com/purview-dev/purview-telemetry-sourcegenerator/tree/main/samples/SampleApp) Project to see the Activities, Logging, and Metrics working with the Aspire Dashboard.
 

bun.lock

@@ -1,6 +1,6 @@
 {
 	"name": "purview-telemetry-sourcegenerator",
-	"version": "1.0.0",
+	"version": "2.0.1",
 	"description": "Generates [ActivitySource](https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.activitysource), [High-performance logging](https://learn.microsoft.com/en-us/dotnet/core/extensions/high-performance-logging) and [Metrics](https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.metrics) based on methods on an interface, enabling fast iteration cycles, dependency injection and substitutes for testing.",
 	"main": "index.js",
 	"scripts": {
@@ -18,10 +18,10 @@
 	},
 	"homepage": "https://github.com/purview-dev/purview-telemetry-sourcegenerator#readme",
 	"devDependencies": {
-		"@commitlint/cli": "^19.6.1",
-		"@commitlint/config-conventional": "^19.6.0",
+		"@commitlint/cli": "^19.7.1",
+		"@commitlint/config-conventional": "^19.7.1",
 		"commit-and-tag-version": "^12.5.0",
-		"commitlint": "^19.6.1",
+		"commitlint": "^19.7.1",
 		"husky": "^9.1.7"
 	},
 	"commitlint": {

package.json

@@ -6,11 +6,11 @@
 		<ImplicitUsings>enable</ImplicitUsings>
 		<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
 		<GenerateDocumentationFile>true</GenerateDocumentationFile>
-		<NoWarn>$(NoWarn);CS1591;</NoWarn>
+		<NoWarn>$(NoWarn);CS1591</NoWarn>
 	</PropertyGroup>
 
 	<ItemGroup>
-		<PackageReference Include="Purview.Telemetry.SourceGenerator" Version="2.0.0">
+		<PackageReference Include="Purview.Telemetry.SourceGenerator" Version="2.0.1">
 			<PrivateAssets>all</PrivateAssets>
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
 		</PackageReference>