First commit

Author: PaulNonatomic

CHANGELOG.md

@@ -1,4 +1,4 @@
 # Change Log
 
-## [0.0.0-beta] - MM DD, YYYY
+## [0.0.0-beta] - Sept 28, 2024
 - First commit

CHANGELOG.md.meta

@@ -1,6 +1,6 @@
 # Contributing to MyPackage
 
-First off, thank you for considering contributing to MyPackage. Any contributions you make are **greatly appreciated**.
+First off, thank you for considering contributing to the Timers package. Any contributions you make are **greatly appreciated**.
 
 ## How to Contribute
 
@@ -9,7 +9,7 @@ There are many ways you can contribute to our project:
 - Submitting bug reports and feature requests
 - Writing tutorials or blog posts
 - Improving the documentation
-- Writing code which can be incorporated into MyPackage itself
+- Writing code which can be incorporated into the Timers package itself
 
 ### Reporting Bugs
 
@@ -30,7 +30,7 @@ Here's how you can make a pull request (PR) to the project:
 
 ## Coding Guidelines
 
-MyPackage follows the [Microsoft C# Coding Conventions](https://docs.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/coding-conventions). Please ensure your code contributions adhere to these standards.
+The Timers package follows the [Microsoft C# Coding Conventions](https://docs.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/coding-conventions). Please ensure your code contributions adhere to these standards.
 
 ## Local Development
 
@@ -43,10 +43,10 @@ Respect our code of conduct, be kind to each other, and help out with the projec
 
 ## License
 
-By contributing to MyPackage, you agree that your contributions will be licensed under MIT.
+By contributing to the Timers package, you agree that your contributions will be licensed under MIT.
 
 ## Questions?
 
 If you have any questions, please feel free to contact paul@nonatomic.co.uk
 
-Thank you for contributing to MyPackage.
+Thank you for contributing to the Timers package.

CONTRIBUTING.md

@@ -1,8 +1,8 @@
 {
-    "name": "com.nonatomic.mypackage.editor",
-    "rootNamespace": "Nonatomic.MyPackage",
+    "name": "com.nonatomic.timers.editor",
+    "rootNamespace": "",
     "references": [
-        "com.nonatomic.mypackage.runtime"
+        "com.nonatomic.timers.runtime"
     ],
     "includePlatforms": [
         "Editor"

CONTRIBUTING.md.meta

@@ -1,16 +1,40 @@
-# MyPackage #
+# Timers #
 
 ## Overview ##
-MyPackage is a Unity package designed to ...
+Timer is a versatile, easy-to-use timer component designed for Unity projects. It supports basic timing operations like start, stop, and reset, along with advanced features such as pausing, resuming, fast forwarding, rewinding, and handling milestones that trigger custom actions.
+
+### Features
+- Basic Timer Operations: Start, stop, and reset the timer.
+- Pause and Resume: Pause the timer and resume from the last stopped point without resetting.
+- Fast Forward and Rewind: Jump forward or backward in time.
+- **Milestones:** Set up callbacks to execute when the timer reaches certain points.
+- **Serialization:** Serialize and deserialize the timer's state, useful for game saves.
+- **Extensible:** Easy to extend with additional features and integrate into larger systems.
 
 ## Installation ##
-To install MyPackage in your Unity project, add the package from the git URL: https://github.com/PaulNonatomic/MyPackage.git using the Unity package manager.
+To install the Timers package in your Unity project, follow these steps:
+
+1. Open Unity and navigate to the Package Manager.
+   - Click on the + button and select Add package from git URL...
+   - Enter the following URL: https://github.com/PaulNonatomic/Timer and press Add.
+2. Add the Timer component onto any active GameObject in your scene, or create a new GameObject dedicated to the timer.
+
+## Usage ## 
 
-## Usage ##
-...
+## API Reference ##
+* StartTimer(): Start or restart the timer.
+* StopTimer(): Pause the timer.
+* ResetTimer(): Reset the timer to its initial state.
+* ResumeTimer(): Resume the timer from the last paused state.
+* FastForward(float seconds): Advance the timer by a specified number of seconds.
+* Rewind(float seconds): Reverse the timer by a specified number of seconds.
+* AddMilestone(TimerMilestone milestone): Add a milestone that triggers a callback when reached.
+* RemoveMilestone(TimerMilestone milestone): Remove a milestone from the timer.
+* ClearMilestones(): Clears all milestones from the timer, ceasing any pending triggers.
+* RemoveMilestonesByCondition(Predicate<TimerMilestone> condition): Removes a specific milestone from the timer.
 
 ## Contributing ##
 Contributions are welcome! Please refer to CONTRIBUTING.md for guidelines on how to contribute.
 
 ## License ##
-MyPackage is licensed under the MIT license. See LICENSE for more details.
+The Timers package is licensed under the MIT license. See LICENSE for more details.