From 34f99434b9ff97640f1c6997a2c643d039606c8f Mon Sep 17 00:00:00 2001
From: Sebastian Bularca <sebastian@jovian.se>
Date: Sun, 12 Apr 2026 19:19:04 +0200
Subject: [PATCH] finished readme

---
 Assets/Database/Game/CalendarSettings.asset   |  2 +-
 .../com.jovian.calendar/Samples~/README.md    | 14 +++++++++
 .../Samples~/Settings/CalendarSettings.asset  | 29 +++++++++++++++++++
 3 files changed, 44 insertions(+), 1 deletion(-)
 create mode 100644 Packages/com.jovian.calendar/Samples~/README.md
 create mode 100644 Packages/com.jovian.calendar/Samples~/Settings/CalendarSettings.asset

diff --git a/Assets/Database/Game/CalendarSettings.asset b/Assets/Database/Game/CalendarSettings.asset
index be9df1c..3865f50 100644
--- a/Assets/Database/Game/CalendarSettings.asset
+++ b/Assets/Database/Game/CalendarSettings.asset
@@ -24,6 +24,6 @@ MonoBehaviour:
   daysPerWeek: 7
   startYear: 4232
   startMonth: 1
-  startDay: 0
+  startDay: 1
   startHour: 8
   startMinute: 0
diff --git a/Packages/com.jovian.calendar/Samples~/README.md b/Packages/com.jovian.calendar/Samples~/README.md
new file mode 100644
index 0000000..188613d
--- /dev/null
+++ b/Packages/com.jovian.calendar/Samples~/README.md
@@ -0,0 +1,14 @@
+# Calendar Samples
+
+## Settings
+
+| Asset | Description |
+|---|---|
+| `CalendarSettings` | Example calendar configuration with fantasy month names and a 10-second day cycle |
+
+## How to use
+
+1. Import the samples via the Unity Package Manager (select the package, expand Samples, click Import)
+2. Copy the CalendarSettings asset into your project
+3. Adjust the values to match your game's calendar (day length, months, month names, etc.)
+4. Load via Addressables or direct reference and pass to `new WorldClock(settings)`
diff --git a/Packages/com.jovian.calendar/Samples~/Settings/CalendarSettings.asset b/Packages/com.jovian.calendar/Samples~/Settings/CalendarSettings.asset
new file mode 100644
index 0000000..be9df1c
--- /dev/null
+++ b/Packages/com.jovian.calendar/Samples~/Settings/CalendarSettings.asset
@@ -0,0 +1,29 @@
+%YAML 1.1
+%TAG !u! tag:unity3d.com,2011:
+--- !u!114 &11400000
+MonoBehaviour:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 0}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: e3a6df85a820d0a4db469ae8a20ea773, type: 3}
+  m_Name: CalendarSettings
+  m_EditorClassIdentifier: Assembly-CSharp::Nox.Game.CalendarSettings
+  secondsPerFullDay: 60
+  hoursPerDay: 24
+  minutesPerHour: 60
+  daysPerMonth: 5a0000005a0000005a0000005a000000
+  monthNames:
+  - Ashveil
+  - Thornmere
+  - Duskhollow
+  - 'Frosthollow '
+  daysPerWeek: 7
+  startYear: 4232
+  startMonth: 1
+  startDay: 0
+  startHour: 8
+  startMinute: 0