Merge branch 'main' into develop

PaulNonatomic · PaulNonatomic · commit 6e47902b5872 · 2025-08-20T12:18:38.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
 # Change Log
 
+## [0.4.2] - Aug 20, 2025
+- The Timers package has been renamed to TimerKit
+
 ## [0.4.1] - Aug 20, 2025
 - Added ServiceKit support
 
diff --git a/README.md b/README.md
@@ -1,7 +1,14 @@
-# Timers
+<div align=center>   
 
-## Overview
-**Timers** is a versatile, easy-to-use timer component designed for Unity projects. Whether you're building a countdown for a game level, managing cooldowns, or triggering events at specific intervals, this package provides a robust solution. It combines basic timing functionality with advanced features, all wrapped in an extensible and Unity-friendly design.
+<p align="center">
+  <img src="Readme~\logo.png" width="500">
+</p>
+
+### TimerKit is a versatile, easy-to-use timer component designed for [Unity](https://unity.com/)
+
+Whether you're building a countdown for a game level, managing cooldowns, or triggering events at specific intervals, TimerKit provides a robust solution. It combines basic timing functionality with advanced features, all wrapped in an extensible and Unity-friendly design.
+
+</div>
 
 ### Features
 - **Basic Operations**: Start, stop, reset, and query the timer's state.
@@ -15,11 +22,11 @@
 - **Service Locator Support**: Optional integration with dependency injection patterns.
 
 ## Installation
-Add the Timers package to your Unity project via the Unity Package Manager:
+Add the TimerKit package to your Unity project via the Unity Package Manager:
 
 1. Open the Package Manager (`Window > Package Manager`).
 2. Click the **+** button and select **"Add package from git URL"**.
-3. Enter: `https://github.com/PaulNonatomic/Timer.git`.
+3. Enter: `https://github.com/PaulNonatomic/TimerKit.git`.
 4. Click **Add**.
 
 ## Timer Architecture
@@ -46,7 +53,7 @@ The package provides a flexible hierarchy of timer classes to suit different nee
 For Unity integration with Inspector support:
 
 ```csharp
-using Nonatomic.Timers;
+using Nonatomic.TimerKit;
 using UnityEngine;
 
 public class CountdownExample : MonoBehaviour
@@ -67,7 +74,7 @@ public class CountdownExample : MonoBehaviour
 For pure C# usage without Unity dependencies:
 
 ```csharp
-using Nonatomic.Timers;
+using Nonatomic.TimerKit;
 
 public class StandaloneExample
 {
diff --git a/Readme~/logo.png b/Readme~/logo.png
diff --git a/Runtime/BasicTimer.cs b/Runtime/BasicTimer.cs
@@ -1,7 +1,7 @@
 using System;
 using UnityEngine;
 
-namespace Nonatomic.Timers
+namespace Nonatomic.TimerKit
 {
 	/// <summary>
 	/// A basic countdown timer implementation without milestone support.
diff --git a/Runtime/Extensions/ServiceKit/BaseTimerService.cs b/Runtime/Extensions/ServiceKit/BaseTimerService.cs
@@ -1,9 +1,9 @@
 ﻿using System;
 using Nonatomic.ServiceKit;
 
-#if TIMERS_SERVICE_KIT
+#if TIMERKIT_SERVICEKIT_SUPPORT
 
-namespace Nonatomic.Timers.Extensions.ServiceKit
+namespace Nonatomic.TimerKit.Extensions.ServiceKit
 {
 	public interface IBaseTimerService : ITimer
 	{
diff --git a/Runtime/Extensions/ServiceKit/TimerService.cs b/Runtime/Extensions/ServiceKit/TimerService.cs
@@ -1,6 +1,6 @@
-﻿#if TIMERS_SERVICE_KIT
+﻿#if TIMERKIT_SERVICEKIT_SUPPORT
 
-namespace Nonatomic.Timers.Extensions.ServiceKit
+namespace Nonatomic.TimerKit.Extensions.ServiceKit
 {
 	public interface ITimerService : IBaseTimerService
 	{
diff --git a/Runtime/Extensions/ServiceLocator/BaseTimerService.cs b/Runtime/Extensions/ServiceLocator/BaseTimerService.cs
@@ -1,10 +1,10 @@
-﻿#if TIMERS_SERVICE_LOCATOR
+﻿#if TIMERKIT_SERVICE_LOCATOR_SUPPORT
 
 using System;
 using Nonatomic.ServiceLocator;
 using UnityEngine;
 
-namespace Nonatomic.Timers.Extensions.ServiceLocator
+namespace Nonatomic.TimerKit.Extensions.ServiceLocator
 {
 	public interface IBaseTimerService : ITimer
 	{
diff --git a/Runtime/Extensions/ServiceLocator/TimerService.cs b/Runtime/Extensions/ServiceLocator/TimerService.cs
@@ -1,6 +1,6 @@
-﻿#if TIMERS_SERVICE_LOCATOR
+﻿#if TIMERKIT_SERVICE_LOCATOR_SUPPORT
 
-namespace Nonatomic.Timers.Extensions.ServiceLocator
+namespace Nonatomic.TimerKit.Extensions.ServiceLocator
 {
 	public interface ITimerService : IBaseTimerService
 	{
diff --git a/Runtime/IBasicTimer.cs b/Runtime/IBasicTimer.cs
@@ -1,6 +1,6 @@
 using System;
 
-namespace Nonatomic.Timers
+namespace Nonatomic.TimerKit
 {
 	/// <summary>
 	/// Defines a contract for basic timer functionality without milestone support.
diff --git a/Runtime/IReadOnlyTimer.cs b/Runtime/IReadOnlyTimer.cs
@@ -1,4 +1,4 @@
-﻿namespace Nonatomic.Timers
+﻿namespace Nonatomic.TimerKit
 {
 	public interface IReadOnlyTimer
 	{
diff --git a/Runtime/ITimer.cs b/Runtime/ITimer.cs
@@ -1,6 +1,6 @@
 ﻿using System;
 
-namespace Nonatomic.Timers
+namespace Nonatomic.TimerKit
 {
 	/// <summary>
 	/// Defines a contract for timer functionality with milestone support.
diff --git a/Runtime/MilestoneTimer.cs b/Runtime/MilestoneTimer.cs
@@ -2,7 +2,7 @@
 using System.Collections.Generic;
 using System.Linq;
 
-namespace Nonatomic.Timers
+namespace Nonatomic.TimerKit
 {
 	/// <summary>
 	/// A timer that extends BasicTimer with milestone support.
diff --git a/Runtime/SimpleTimer.cs b/Runtime/SimpleTimer.cs
@@ -1,7 +1,7 @@
 using System;
 using UnityEngine;
 
-namespace Nonatomic.Timers
+namespace Nonatomic.TimerKit
 {
 	/// <summary>
 	/// [DEPRECATED] This class has been renamed to StandardTimer for clarity.
diff --git a/Runtime/StandardTimer.cs b/Runtime/StandardTimer.cs
@@ -1,7 +1,7 @@
 using System;
 using UnityEngine;
 
-namespace Nonatomic.Timers
+namespace Nonatomic.TimerKit
 {
 	/// <summary>
 	/// The standard full-featured timer implementation with milestone support and serialization.
diff --git a/Runtime/TimeType.cs b/Runtime/TimeType.cs
@@ -1,4 +1,4 @@
-﻿namespace Nonatomic.Timers
+﻿namespace Nonatomic.TimerKit
 {
 	public enum TimeType
 	{
diff --git a/Runtime/Timer.cs b/Runtime/Timer.cs
@@ -1,7 +1,7 @@
 ﻿using System;
 using UnityEngine;
 
-namespace Nonatomic.Timers
+namespace Nonatomic.TimerKit
 {
 	/// <summary>
 	/// A MonoBehaviour that manages a timer, allowing it to be used within the Unity lifecycle.
diff --git a/Runtime/TimerMilestone.cs b/Runtime/TimerMilestone.cs
@@ -1,6 +1,6 @@
 ﻿using System;
 
-namespace Nonatomic.Timers
+namespace Nonatomic.TimerKit
 {
 	public class TimerMilestone
 	{
diff --git a/Runtime/TimerRangeMilestone.cs b/Runtime/TimerRangeMilestone.cs
@@ -1,6 +1,6 @@
 using System;
 
-namespace Nonatomic.Timers
+namespace Nonatomic.TimerKit
 {
 	/// <summary>
 	/// Represents a range-based milestone that triggers callbacks at regular intervals within a specified range.
diff --git a/Runtime/TimerUtility.cs b/Runtime/TimerUtility.cs
@@ -1,4 +1,4 @@
-﻿namespace Nonatomic.Timers
+﻿namespace Nonatomic.TimerKit
 {
 	using System;
 	using static System.TimeSpan;
diff --git a/Runtime/com.nonatomic.timerkit.runtime.asmdef b/Runtime/com.nonatomic.timerkit.runtime.asmdef
@@ -1,6 +1,6 @@
 {
-    "name": "com.nonatomic.timers.runtime",
-    "rootNamespace": "Nonatomic.Timers",
+    "name": "com.nonatomic.timerkit.runtime",
+    "rootNamespace": "Nonatomic.TimerKit",
     "references": [
         "GUID:d8c8bb452aae45acbab36298ba796881",
         "GUID:1b0144b25b4099e45a5beb8f8f7bee63"
@@ -16,12 +16,12 @@
         {
             "name": "com.nonatomic.servicelocator",
             "expression": "0.5.0",
-            "define": "TIMERS_SERVICE_LOCATOR"
+            "define": "TIMERKIT_SERVICE_LOCATOR_SUPPORT"
         },
         {
             "name": "com.nonatomic.servicekit",
             "expression": "1.3.3",
-            "define": "TIMERS_SERVICE_KIT"
+            "define": "TIMERKIT_SERVICEKIT_SUPPORT"
         }
     ],
     "noEngineReferences": false
diff --git a/Runtime/com.nonatomic.timerkit.runtime.asmdef.meta b/Runtime/com.nonatomic.timerkit.runtime.asmdef.meta
diff --git a/Runtime/com.nonatomic.timers.runtime.asmdef.meta b/Runtime/com.nonatomic.timers.runtime.asmdef.meta
diff --git a/Tests/EditMode/SimpleTimerTests.cs b/Tests/EditMode/SimpleTimerTests.cs
@@ -1,8 +1,8 @@
 ﻿using NUnit.Framework;
-using Nonatomic.Timers;
 using System.Collections.Generic;
 using UnityEngine;
 using System;
+using Nonatomic.TimerKit;
 
 namespace Tests.EditMode
 {
diff --git a/Tests/EditMode/com.nonatomic.timerkit.tests.editmode.asmdef b/Tests/EditMode/com.nonatomic.timerkit.tests.editmode.asmdef
@@ -1,8 +1,9 @@
 {
-    "name": "com.nonatomic.timers.tests.editmode",
+    "name": "com.nonatomic.timerkit.tests.editmode",
     "rootNamespace": "",
     "references": [
-        "GUID:7946017d952266a43a1e3ab40f758d92"
+        "GUID:7946017d952266a43a1e3ab40f758d92",
+        "GUID:eb6b9fe13e7dd23478fca248f8928c7c"
     ],
     "includePlatforms": [
         "Editor"
diff --git a/Tests/EditMode/com.nonatomic.timerkit.tests.editmode.asmdef.meta b/Tests/EditMode/com.nonatomic.timerkit.tests.editmode.asmdef.meta
diff --git a/Tests/EditMode/com.nonatomic.timers.tests.editmode.asmdef.meta b/Tests/EditMode/com.nonatomic.timers.tests.editmode.asmdef.meta
diff --git a/package.json b/package.json
@@ -1,12 +1,12 @@
 ﻿{
-  "name": "com.nonatomic.timers",
-  "version": "0.4.1",
-  "displayName": "Timers",
-  "description": "Timers",
+  "name": "com.nonatomic.timerkit",
+  "version": "0.4.2",
+  "displayName": "TimerKit",
+  "description": "TimerKit",
   "unity": "2022.3",
   "unityRelease": "1f1",
-  "documentationUrl": "https://github.com/PaulNonatomic/Timer/blob/main/README.md",
-  "changelogUrl": "https://github.com/PaulNonatomic/Timer/blob/main/CHANGELOG.md",
+  "documentationUrl": "https://github.com/PaulNonatomic/TimerKit/blob/main/README.md",
+  "changelogUrl": "https://github.com/PaulNonatomic/TimerKit/blob/main/CHANGELOG.md",
   "dependencies": {
     "com.unity.test-framework": "1.3.9"
   },
@@ -22,10 +22,10 @@
   "type": "tool",
   "repository": {
     "type": "git",
-    "url": "git@github.com:PaulNonatomic/Timer.git"
+    "url": "git@github.com:PaulNonatomic/TimerKit.git"
   },
   "testables": [
-    "com.nonatomic.timers.tests.editmode"
+    "com.nonatomic.timerkit.tests.editmode"
   ],
   "samples": [
    

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`using System;`
`2`	`2`	`using UnityEngine;`
`3`	`3`
`4`		`-namespace Nonatomic.Timers`
	`4`	`+namespace Nonatomic.TimerKit`
`5`	`5`	`{`
`6`	`6`	`/// <summary>`
`7`	`7`	`/// A basic countdown timer implementation without milestone support.`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,9 @@`
`1`	`1`	`using System;`
`2`	`2`	`using Nonatomic.ServiceKit;`
`3`	`3`
`4`		`-#if TIMERS_SERVICE_KIT`
	`4`	`+#if TIMERKIT_SERVICEKIT_SUPPORT`
`5`	`5`
`6`		`-namespace Nonatomic.Timers.Extensions.ServiceKit`
	`6`	`+namespace Nonatomic.TimerKit.Extensions.ServiceKit`
`7`	`7`	`{`
`8`	`8`	`public interface IBaseTimerService : ITimer`
`9`	`9`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`		`-#if TIMERS_SERVICE_KIT`
	`1`	`+#if TIMERKIT_SERVICEKIT_SUPPORT`
`2`	`2`
`3`		`-namespace Nonatomic.Timers.Extensions.ServiceKit`
	`3`	`+namespace Nonatomic.TimerKit.Extensions.ServiceKit`
`4`	`4`	`{`
`5`	`5`	`public interface ITimerService : IBaseTimerService`
`6`	`6`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,10 @@`
`1`		`-#if TIMERS_SERVICE_LOCATOR`
	`1`	`+#if TIMERKIT_SERVICE_LOCATOR_SUPPORT`
`2`	`2`
`3`	`3`	`using System;`
`4`	`4`	`using Nonatomic.ServiceLocator;`
`5`	`5`	`using UnityEngine;`
`6`	`6`
`7`		`-namespace Nonatomic.Timers.Extensions.ServiceLocator`
	`7`	`+namespace Nonatomic.TimerKit.Extensions.ServiceLocator`
`8`	`8`	`{`
`9`	`9`	`public interface IBaseTimerService : ITimer`
`10`	`10`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-namespace Nonatomic.Timers`
	`1`	`+namespace Nonatomic.TimerKit`
`2`	`2`	`{`
`3`	`3`	`public interface IReadOnlyTimer`
`4`	`4`	`{`