chore: Preparing for release 0.0.2 (#38)

* chore: Preparing for release 0.0.1 * revert change * Update README.md * Rebuild with correct README and bumped to 0.0.2 * Update README.md
MindscapeHQ · Aug 23, 2024 · bdd2f10 · bdd2f10
1 parent ac2c2d1
commit bdd2f10
Show file tree

Hide file tree

Showing 8 changed files with 172 additions and 95 deletions.
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -0,0 +1,15 @@
+Copyright (C) 2024 Raygun Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
+THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -4,24 +4,27 @@
 
 ### Installation
 
-- [ ] TODO: Package installation instructions. e.g.
+#### NuGet Package manager
+The best way to install Raygun is to use the NuGet package manager. Right-click on your project and select "**Manage NuGet Packages....**". Navigate to the Browse tab, then use the search box to find **Raygun.Blazor** and install it.
 
-```
-dotnet add package <something>
-```
-
-### Setup
+#### .NET Cli
 
-#### Using `WebAssemblyHostBuilder` to create the client
+To install the latest version:
 
-Use `UseRaygunBlazor` extension to configure the `RaygunBlazorClient` and related services for use in a Blazor WebAssembly application.
+``` 
+dotnet add package Raygun.Blazor
+```
 
-```cs
-var builder = WebAssemblyHostBuilder.CreateDefault(args);
+Alternatively, you can specify a version tag to install a specific version of the package. See [Raygun.Blazor NuGet Gallery page](https://nuget.org/packages/Raygun.Blazor) for information on available versions.
 
-builder.UseRaygunBlazor();
+```
+dotnet add package Raygun.Blazor --version x.y.z
 ```
 
+### Setup
+
+See the section **Blazor WebAssembly** and **Blazor Server** for specific setup instructions depending on the project type.
+
 #### Raygun Settings
 
 Raygun for Blazor uses the `appsettings.json` to load configuration settings.
@@ -161,6 +164,10 @@ For all configuration values, check the `RaygunLogLevel` enum under `src/Raygun.
 
 ## Blazor WebAssembly
 
+### Installation
+
+Install the package `Raygun.Blazor.WebAssembly` from NuGet.
+
 ### Setup
 
 - [ ] TODO: setup WebAssembly instructions
@@ -190,7 +197,7 @@ A browser window to `http://localhost:5010/` should automatically open.
 
 ### Installation
 
-- [ ] TODO: NuGet install instructions
+Install the package `Raygun.Blazor.Server` from NuGet.
 
 ### Setup
 
@@ -272,6 +279,14 @@ A browser window to `http://localhost:5010/` should automatically open.
 
 ---
 
-## Publishing
+## Development
+
+### To build a local nuget package
+
+- Open Visual Studio 22+
+- Open the `Raygun.Blazor.sln` solution
+- Right-click the project and select properties
+- Ensure the produce a NuGet package build option is checked
+- Under package, update the version name
 
-- [ ] TODO: Packagre publishing instructions, e.g. NuGet publish instructions
+Each time you build your project a .nupkg file will be created in your bin directory.
diff --git a/Raygun-icon-128x128.png b/Raygun-icon-128x128.png
diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -30,13 +30,11 @@
 	</PropertyGroup>
 
 	<PropertyGroup>
-		<Product>Raygun</Product>
-		<Authors>Robert McLaws</Authors>
+		<Authors>Raygun Limited</Authors>
 		<Company>Raygun Limited</Company>
 		<RpmPackageVendor>Raygun</RpmPackageVendor>
 		<Copyright>Copyright © 2024-2025 Raygun Limited. All rights reserved.</Copyright>
 		<NeutralLanguage>en-US</NeutralLanguage>
-		<PackageLicenseExpression>MIT</PackageLicenseExpression>
 		<!--
       Suppress a warning about upcoming deprecation of PackageLicenseUrl. When embedding licenses are supported,
       replace PackageLicenseUrl with PackageLicenseExpression.
@@ -45,13 +43,8 @@
 		<!-- Suppress warnings about using SemVer 2.0. -->
 		<NoWarn>$(NoWarn);NU5105</NoWarn>
 
-		<!-- Contact email address for NuGet packages and Linux installers. -->
-		<!--<MaintainerEmail>[email protected]</MaintainerEmail>-->
-
-		<PackageIcon>raygun.png</PackageIcon>
 		<PackageProjectUrl>https://github.com/MindscapeHQ/raygun4blazor</PackageProjectUrl>
 		<PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
-		<PackageTags>raygun;blazor</PackageTags>
 		<Serviceable>true</Serviceable>
 
 		<RepositoryRoot>$(MSBuildThisFileDirectory)</RepositoryRoot>

diff --git a/src/Raygun.Blazor.Server/Raygun.Blazor.Server.csproj b/src/Raygun.Blazor.Server/Raygun.Blazor.Server.csproj
@@ -5,16 +5,32 @@
         <DocumentationFile>$(DocumentationFile)\$(AssemblyName).xml</DocumentationFile>
         <RootNamespace>Raygun.Blazor.Server</RootNamespace>
         <PackageReadmeFile>README.md</PackageReadmeFile>
+
+        <!-- NuGet Package config -->
+        <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
+        <Version>0.0.2</Version>
+        <PackageVersion>0.0.2</PackageVersion>
+        <Authors>Raygun Limited</Authors>
+        <Title>Raygun for Blazor Server</Title>
+        <Description>Raygun's Crash Reporting extension for Blazor Server</Description>
+        <Product>Raygun4Blazor.Server</Product>
+        <PackageTags>Raygun; Crash Reporting; Blazor; .NET; dotnet; Server</PackageTags>
+        <PackageLicenseFile>LICENSE.txt</PackageLicenseFile>
+        <PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
+        <PackageIcon>Raygun-icon-128x128.png</PackageIcon>
+        <!-- End NuGet Package config -->
     </PropertyGroup>
 
     <ItemGroup>
         <!-- Package Readme File at root of repo -->
         <None Include="../../README.md" Pack="true" PackagePath="" />
+        <None Include="../../LICENSE.txt" Pack="true" PackagePath="" />
+        <None Include="../../Raygun-icon-128x128.png" Pack="true" PackagePath="" />
     </ItemGroup>
 
     <ItemGroup>
         <ProjectReference Include="..\Raygun.Blazor\Raygun.Blazor.csproj" />
         <FrameworkReference Include="Microsoft.AspNetCore.App" />
     </ItemGroup>
-    
+
 </Project>
diff --git a/src/Raygun.Blazor.WebAssembly/Raygun.Blazor.WebAssembly.csproj b/src/Raygun.Blazor.WebAssembly/Raygun.Blazor.WebAssembly.csproj
@@ -1,21 +1,43 @@
 <Project Sdk="Microsoft.NET.Sdk.Razor">
-
-	<PropertyGroup>
-		<TargetFrameworks>net8.0;</TargetFrameworks>
-		<DocumentationFile>$(DocumentationFile)\$(AssemblyName).xml</DocumentationFile>
-		<RootNamespace>Raygun.Blazor.WebAssembly</RootNamespace>
-	</PropertyGroup>
 
-	<ItemGroup>
-		<SupportedPlatform Include="browser" />
-	</ItemGroup>
+    <PropertyGroup>
+        <TargetFrameworks>net8.0;</TargetFrameworks>
+        <DocumentationFile>$(DocumentationFile)\$(AssemblyName).xml</DocumentationFile>
+        <RootNamespace>Raygun.Blazor.WebAssembly</RootNamespace>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
 
-	<ItemGroup>
-	  <PackageReference Include="Microsoft.AspNetCore.Components.WebAssembly" Version="8.*" />
-	</ItemGroup>
+        <!-- NuGet Package config -->
+        <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
+        <Version>0.0.2</Version>
+        <PackageVersion>0.0.2</PackageVersion>
+        <Authors>Raygun Limited</Authors>
+        <Title>Raygun for Blazor WebAssembly</Title>
+        <Description>Raygun's Crash Reporting extension for Blazor WebAssembly</Description>
+        <Product>Raygun4Blazor.WebAssembly</Product>
+        <PackageTags>Raygun; Crash Reporting; Blazor; .NET; dotnet; WebAssembly</PackageTags>
+        <PackageLicenseFile>LICENSE.txt</PackageLicenseFile>
+        <PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
+        <PackageIcon>Raygun-icon-128x128.png</PackageIcon>
+        <!-- End NuGet Package config -->
+    </PropertyGroup>
+
+    <ItemGroup>
+        <!-- Package Readme File at root of repo -->
+        <None Include="../../README.md" Pack="true" PackagePath="" />
+        <None Include="../../LICENSE.txt" Pack="true" PackagePath="" />
+        <None Include="../../Raygun-icon-128x128.png" Pack="true" PackagePath="" />
+    </ItemGroup>
+
+    <ItemGroup>
+        <SupportedPlatform Include="browser" />
+    </ItemGroup>
+
+    <ItemGroup>
+        <PackageReference Include="Microsoft.AspNetCore.Components.WebAssembly" Version="8.*" />
+    </ItemGroup>
+
+    <ItemGroup>
+        <ProjectReference Include="..\Raygun.Blazor\Raygun.Blazor.csproj" />
+    </ItemGroup>
 
-	<ItemGroup>
-		<ProjectReference Include="..\Raygun.Blazor\Raygun.Blazor.csproj" />
-	</ItemGroup>
-
 </Project>
diff --git a/src/Raygun.Blazor.sln b/src/Raygun.Blazor.sln
@@ -30,7 +30,7 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Raygun.Blazor.Server", "Ray
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Raygun.Samples.Blazor.WebAssembly", "Raygun.Samples.Blazor.WebAssembly\Raygun.Samples.Blazor.WebAssembly.csproj", "{CDBE774B-4AEA-4277-9044-A9718C03CEF6}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Raygun.Samples.Blazor.Server", "Raygun.Samples.Blazor.Server\Raygun.Samples.Blazor.Server.csproj", "{333DF481-7A4F-4C9A-981F-63C954D0414D}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Raygun.Samples.Blazor.Server", "Raygun.Samples.Blazor.Server\Raygun.Samples.Blazor.Server.csproj", "{333DF481-7A4F-4C9A-981F-63C954D0414D}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution

diff --git a/src/Raygun.Blazor/Raygun.Blazor.csproj b/src/Raygun.Blazor/Raygun.Blazor.csproj
@@ -1,60 +1,76 @@
 <Project Sdk="Microsoft.NET.Sdk.Razor">
 
-	<PropertyGroup>
-		<TargetFrameworks>net8.0;</TargetFrameworks>
-		<DocumentationFile>$(DocumentationFile)\$(AssemblyName).xml</DocumentationFile>
-		<PackageReadmeFile>README.md</PackageReadmeFile>
-		<AddRazorSupportForMvc>true</AddRazorSupportForMvc>		
-		<Nullable>enable</Nullable>
-
-		<TypeScriptModuleKind>commonjs</TypeScriptModuleKind>
-		<TypeScriptTarget>ES2020</TypeScriptTarget>
-		<TypeScriptOutDir>wwwroot</TypeScriptOutDir>
-		<RootNamespace>Raygun.Blazor</RootNamespace>
-	</PropertyGroup>
-
-	<ItemGroup>
-		<!-- Package Readme File at root of repo -->
-		<None Include="../../README.md" Pack="true" PackagePath="" />
-	</ItemGroup>
-
-	<ItemGroup>
-		<PackageReference Include="Ben.Demystifier" Version="[0.*, 1.0.0)" />
-		<PackageReference Include="KristofferStrube.Blazor.Window" Version="0.*-*" />
-		<PackageReference Include="MyCSharp.HttpUserAgentParser" Version="[3.*, 4.0.0]" />
-		<PackageReference Include="Microsoft.TypeScript.MSBuild" Version="5.5.2">
-			<PrivateAssets>all</PrivateAssets>
-			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-		</PackageReference>
-	</ItemGroup>
-
-	<ItemGroup Condition="'$(TargetFramework)' == 'net8.0'">
-		<PackageReference Include="Microsoft.AspNetCore.Components.Web" Version="[8.*, 9.0.0)" />
-		<PackageReference Include="Microsoft.Extensions.Http" Version="[8.*, 9.0.0)" />
-		<PackageReference Include="Microsoft.JSInterop" Version="[8.*, 9.0.0)" />
-	</ItemGroup>
-
-	<ItemGroup Condition="'$(TargetFramework)' == 'net7.0'">
-		<PackageReference Include="Microsoft.AspNetCore.Components.Web" Version="[7.*, 8.0.0)" />
-		<PackageReference Include="Microsoft.Extensions.Http" Version="[7.*, 8.0.0)" />
-		<PackageReference Include="Microsoft.JSInterop" Version="[7.*, 8.0.0)" />
-	</ItemGroup>
-
-	<ItemGroup>
-		<SupportedPlatform Include="browser" />
-	</ItemGroup>
-
-	<ItemGroup>
-		<AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleToAttribute">
-			<_Parameter1>Raygun.Blazor.WebAssembly, $(StrongNamePublicKey)</_Parameter1>
-		</AssemblyAttribute>
-	</ItemGroup>
-
-	<ItemGroup>
-		<AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleToAttribute">
-			<_Parameter1>Raygun.Tests.Blazor, $(StrongNamePublicKey)</_Parameter1>
-		</AssemblyAttribute>
-	</ItemGroup>
+    <PropertyGroup>
+        <TargetFrameworks>net8.0;</TargetFrameworks>
+        <DocumentationFile>$(DocumentationFile)\$(AssemblyName).xml</DocumentationFile>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
+        <AddRazorSupportForMvc>true</AddRazorSupportForMvc>
+        <Nullable>enable</Nullable>
+
+        <TypeScriptModuleKind>commonjs</TypeScriptModuleKind>
+        <TypeScriptTarget>ES2020</TypeScriptTarget>
+        <TypeScriptOutDir>wwwroot</TypeScriptOutDir>
+        <RootNamespace>Raygun.Blazor</RootNamespace>
+
+        <!-- NuGet Package config -->
+        <GeneratePackageOnBuild>True</GeneratePackageOnBuild>
+        <Version>0.0.2</Version>
+        <PackageVersion>0.0.2</PackageVersion>
+        <Authors>Raygun Limited</Authors>
+        <Title>Raygun for Blazor</Title>
+        <Description>Raygun's Crash Reporting Provider for Blazor .NET</Description>
+        <Product>Raygun4Blazor</Product>
+        <PackageTags>Raygun; Crash Reporting; Blazor; .NET; dotnet</PackageTags>
+        <PackageLicenseFile>LICENSE.txt</PackageLicenseFile>
+        <PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
+        <PackageIcon>Raygun-icon-128x128.png</PackageIcon>
+        <!-- End NuGet Package config -->
+    </PropertyGroup>
+
+    <ItemGroup>
+        <!-- Package Readme File at root of repo -->
+        <None Include="../../README.md" Pack="true" PackagePath="" />
+        <None Include="../../LICENSE.txt" Pack="true" PackagePath="" />
+        <None Include="../../Raygun-icon-128x128.png" Pack="true" PackagePath="" />
+    </ItemGroup>
+
+    <ItemGroup>
+        <PackageReference Include="Ben.Demystifier" Version="[0.*, 1.0.0)" />
+        <PackageReference Include="KristofferStrube.Blazor.Window" Version="0.*-*" />
+        <PackageReference Include="MyCSharp.HttpUserAgentParser" Version="[3.*, 4.0.0]" />
+        <PackageReference Include="Microsoft.TypeScript.MSBuild" Version="5.5.2">
+            <PrivateAssets>all</PrivateAssets>
+            <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+        </PackageReference>
+    </ItemGroup>
+
+    <ItemGroup Condition="'$(TargetFramework)' == 'net8.0'">
+        <PackageReference Include="Microsoft.AspNetCore.Components.Web" Version="[8.*, 9.0.0)" />
+        <PackageReference Include="Microsoft.Extensions.Http" Version="[8.*, 9.0.0)" />
+        <PackageReference Include="Microsoft.JSInterop" Version="[8.*, 9.0.0)" />
+    </ItemGroup>
+
+    <ItemGroup Condition="'$(TargetFramework)' == 'net7.0'">
+        <PackageReference Include="Microsoft.AspNetCore.Components.Web" Version="[7.*, 8.0.0)" />
+        <PackageReference Include="Microsoft.Extensions.Http" Version="[7.*, 8.0.0)" />
+        <PackageReference Include="Microsoft.JSInterop" Version="[7.*, 8.0.0)" />
+    </ItemGroup>
+
+    <ItemGroup>
+        <SupportedPlatform Include="browser" />
+    </ItemGroup>
+
+    <ItemGroup>
+        <AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleToAttribute">
+            <_Parameter1>Raygun.Blazor.WebAssembly, $(StrongNamePublicKey)</_Parameter1>
+        </AssemblyAttribute>
+    </ItemGroup>
+
+    <ItemGroup>
+        <AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleToAttribute">
+            <_Parameter1>Raygun.Tests.Blazor, $(StrongNamePublicKey)</_Parameter1>
+        </AssemblyAttribute>
+    </ItemGroup>
 
 
 </Project>