TheDialgaTeam.Serilog

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. License

About This Library

This library provides custom sinks for Serilog.

(back to top)

Built With

• dotnet 8.0 - SDK 8.0.*

(back to top)

Getting Started

Follow the instructions below to install this library on your project.

Prerequisites

You must use a personal access token with the appropriate scopes to install packages in GitHub Packages. For more information, see "About GitHub Packages."

You must replace:

• USERNAME with the name of your user account on GitHub.
• TOKEN with your personal access token.

via dotnet command-line interface (CLI) (persistent)

dotnet nuget add source -n "github/TheDialgaTeam" -u USERNAME -p TOKEN --store-password-in-clear-text https://nuget.pkg.github.com/TheDialgaTeam/index.json

via nuget.config (per project)

Create nuget.config and insert this into the solution.

Note: If you are working on an open source project, you have to add this file into .gitignore if you are sharing into git repository.

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <packageSources>
        <add key="github" value="https://nuget.pkg.github.com/TheDialgaTeam/index.json" />
    </packageSources>
    <packageSourceCredentials>
        <github>
            <add key="Username" value="USERNAME" />
            <add key="ClearTextPassword" value="TOKEN" />
        </github>
    </packageSourceCredentials>
</configuration>

Installation

via dotnet command-line interface (CLI)

To use this package, run the command line below with the version you want to use:

dotnet add package TheDialgaTeam.Serilog --version 1.0.0

via .csproj file

To use this package, add ItemGroup and configure the PackageReference field in the .csproj project file with the version you want to use:

<ItemGroup>
    <PackageReference Include="TheDialgaTeam.Serilog" Version="1.0.0" />
</ItemGroup>

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)