Merge pull request #3 from chickensoft-games/refactor/release

refactor: prep for release

Chickensoft.Log.Tests/test/src/LogTest.cs

@@ -19,6 +19,14 @@ public void Initializes() {
     log.Name.ShouldBe(nameof(LogTest));
   }
 
+  [Fact]
+  public void InitializesWithDefaults() {
+    var mockWriter = new Mock<ILogWriter>();
+    var log = new Log(nameof(LogTest));
+    log.ShouldBeAssignableTo<ILog>();
+    log.Name.ShouldBe(nameof(LogTest));
+  }
+
   [Fact]
   public void PrintsMessage() {
     var formattedTestMsg = Format(TEST_MSG);

Chickensoft.Log/Chickensoft.Log.csproj

@@ -13,23 +13,23 @@
     <OutputPath>./nupkg</OutputPath>
     <DebugType>portable</DebugType>
 
-    <Title>Chickensoft.Log</Title>
+    <Title>Log</Title>
     <Version>0.0.0-devbuild</Version>
-    <Description>Chickensoft.Log description.</Description>
+    <Description>Opinionated logging interface and implementations for C# applications and libraries.</Description>
     <Copyright>© 2025 Chickensoft</Copyright>
     <Authors>Chickensoft</Authors>
     <Company>Chickensoft</Company>
 
     <PackageId>Chickensoft.Log</PackageId>
     <PackageReleaseNotes>Chickensoft.Log release.</PackageReleaseNotes>
     <PackageIcon>icon.png</PackageIcon>
-    <PackageTags />
+    <PackageTags>logging;log;logger;loggers;chickensoft;util;utils</PackageTags>
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
     <PackageProjectUrl></PackageProjectUrl>
 
     <RepositoryType>git</RepositoryType>
-    <RepositoryUrl></RepositoryUrl>
+    <RepositoryUrl>https://github.com/chickensoft-games/Log</RepositoryUrl>
   </PropertyGroup>
 
   <ItemGroup>

Chickensoft.Log/src/Log.cs

@@ -22,19 +22,32 @@ public sealed class Log : ILog {
   public ILogFormatter Formatter { get; set; } = new LogFormatter();
 
   /// <summary>
-  /// Initialize a Log that will use the provided writers.
+  /// Initialize a log that will use the provided writers.
   /// </summary>
   /// <param name="name">
   /// The name associated with this log. Will be included in messages directed
   /// through this log (see <see cref="Name"/>).
   /// A common value is <c>nameof(EncapsulatingClass)</c>.
   /// </param>
   /// <param name="writers">Writers this log will use to write messages.</param>
-  public Log(string name, IList<ILogWriter> writers) {
+  public Log(string name, params ILogWriter[] writers) {
     Name = name;
     _writers = [.. writers];
   }
 
+  /// <summary>
+  /// Creates a log that will output to trace by default.
+  /// </summary>
+  /// <param name="name">
+  /// The name associated with this log. Will be included in messages directed
+  /// through this log (see <see cref="Name"/>).
+  /// A common value is <c>nameof(EncapsulatingClass)</c>.
+  /// </param>
+  public Log(string name) {
+    Name = name;
+    _writers = [new TraceWriter()];
+  }
+
   /// <inheritdoc/>
   public void AddWriter(ILogWriter writer) {
     lock (_writersLock) {

README.md

@@ -1,4 +1,4 @@
-# Chickensoft.Log
+# 🪵 Log
 
 [![Chickensoft Badge][chickensoft-badge]][chickensoft-website]
 [![Discord][discord-badge]][discord]
@@ -15,18 +15,18 @@ and libraries.
 <img alt="Chickensoft.Log" src="Chickensoft.Log/icon.png" width="200">
 </p>
 
-## 🥚 Getting Started
+## 📦 Installation
 
 > [!TIP]
 > For logging in Godot, see [Chickensoft.Log.Godot][log-godot].
 
 Install the latest version of the [Chickensoft.Log] package from nuget:
 
-```xml
-<PackageReference Include="Chickensoft.Log" Version=... />
+```sh
+dotnet add package Chickensoft.Log
 ```
 
-## 🪵 Usage
+## 🌱 Usage
 
 ### Essentials