diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..0ff52f0 --- /dev/null +++ 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. \ No newline at end of file diff --git a/README.md b/README.md index ba6a892..281e8cc 100644 --- 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 -``` - -### 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 new file mode 100644 index 0000000..f56c882 Binary files /dev/null and b/Raygun-icon-128x128.png differ diff --git a/src/Directory.Build.props b/src/Directory.Build.props index fc5ef9c..b794be8 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -30,13 +30,11 @@ - Raygun - Robert McLaws + Raygun Limited Raygun Limited Raygun Copyright © 2024-2025 Raygun Limited. All rights reserved. en-US - MIT $(NoWarn);NU5105 - - - - raygun.png https://github.com/MindscapeHQ/raygun4blazor true - raygun;blazor true $(MSBuildThisFileDirectory) diff --git a/src/Raygun.Blazor.Server/Raygun.Blazor.Server.csproj b/src/Raygun.Blazor.Server/Raygun.Blazor.Server.csproj index 388993d..8243452 100644 --- a/src/Raygun.Blazor.Server/Raygun.Blazor.Server.csproj +++ b/src/Raygun.Blazor.Server/Raygun.Blazor.Server.csproj @@ -5,16 +5,32 @@ $(DocumentationFile)\$(AssemblyName).xml Raygun.Blazor.Server README.md + + + True + 0.0.2 + 0.0.2 + Raygun Limited + Raygun for Blazor Server + Raygun's Crash Reporting extension for Blazor Server + Raygun4Blazor.Server + Raygun; Crash Reporting; Blazor; .NET; dotnet; Server + LICENSE.txt + True + Raygun-icon-128x128.png + + + - + diff --git a/src/Raygun.Blazor.WebAssembly/Raygun.Blazor.WebAssembly.csproj b/src/Raygun.Blazor.WebAssembly/Raygun.Blazor.WebAssembly.csproj index 0475362..aa636f0 100644 --- a/src/Raygun.Blazor.WebAssembly/Raygun.Blazor.WebAssembly.csproj +++ b/src/Raygun.Blazor.WebAssembly/Raygun.Blazor.WebAssembly.csproj @@ -1,21 +1,43 @@  - - - net8.0; - $(DocumentationFile)\$(AssemblyName).xml - Raygun.Blazor.WebAssembly - - - - + + net8.0; + $(DocumentationFile)\$(AssemblyName).xml + Raygun.Blazor.WebAssembly + README.md - - - + + True + 0.0.2 + 0.0.2 + Raygun Limited + Raygun for Blazor WebAssembly + Raygun's Crash Reporting extension for Blazor WebAssembly + Raygun4Blazor.WebAssembly + Raygun; Crash Reporting; Blazor; .NET; dotnet; WebAssembly + LICENSE.txt + True + Raygun-icon-128x128.png + + + + + + + + + + + + + + + + + + + + + - - - - diff --git a/src/Raygun.Blazor.sln b/src/Raygun.Blazor.sln index 51b2dc0..04e783c 100644 --- 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 index 144f8fa..a31eb98 100644 --- a/src/Raygun.Blazor/Raygun.Blazor.csproj +++ b/src/Raygun.Blazor/Raygun.Blazor.csproj @@ -1,60 +1,76 @@  - - net8.0; - $(DocumentationFile)\$(AssemblyName).xml - README.md - true - enable - - commonjs - ES2020 - wwwroot - Raygun.Blazor - - - - - - - - - - - - - all - runtime; build; native; contentfiles; analyzers; buildtransitive - - - - - - - - - - - - - - - - - - - - - - <_Parameter1>Raygun.Blazor.WebAssembly, $(StrongNamePublicKey) - - - - - - <_Parameter1>Raygun.Tests.Blazor, $(StrongNamePublicKey) - - + + net8.0; + $(DocumentationFile)\$(AssemblyName).xml + README.md + true + enable + + commonjs + ES2020 + wwwroot + Raygun.Blazor + + + True + 0.0.2 + 0.0.2 + Raygun Limited + Raygun for Blazor + Raygun's Crash Reporting Provider for Blazor .NET + Raygun4Blazor + Raygun; Crash Reporting; Blazor; .NET; dotnet + LICENSE.txt + True + Raygun-icon-128x128.png + + + + + + + + + + + + + + + + all + runtime; build; native; contentfiles; analyzers; buildtransitive + + + + + + + + + + + + + + + + + + + + + + <_Parameter1>Raygun.Blazor.WebAssembly, $(StrongNamePublicKey) + + + + + + <_Parameter1>Raygun.Tests.Blazor, $(StrongNamePublicKey) + +