Add README and update package.json

Author: HardCodeDev777

LICENSE LICENSE.mdLICENSE renamed to LICENSE.md

@@ -1,2 +1,131 @@
-# UltraTimerWindows
+![Unity](https://img.shields.io/badge/Unity-unity?logo=Unity&color=%23000000)
+![C#](https://img.shields.io/badge/C%23-%23512BD4?logo=.NET)
+![C](https://img.shields.io/badge/C-%23A8B9CC?logo=C&logoColor=%23ffffff)
+![License](https://img.shields.io/github/license/HardCodeDev777/UltraTimerWindows?color=%2305991d)
+![Last commit](https://img.shields.io/github/last-commit/HardCodeDev777/UltraTimerWindows?color=%2305991d)
+![Tag](https://img.shields.io/github/v/tag/HardCodeDev777/UltraTimerWindowsh)
+![Top lang](https://img.shields.io/github/languages/top/HardCodeDev777/UltraTimerWindows)
+ 
 
+
+# 🔥 UltraTimerWindows
+
+---
+
+## 🚀 Overview
+
+**UltraTimerWindows** is a zero-allocation, native high-resolution timer for Unity, built on top of Windows ``QueryPerformanceCounter``. 
+Suitable for micro-benchmarks and hot-path measurements. Provides sub-millisecond and microsecond-level timing precision.
+
+The overhead of the timer itself is negligible compared to typical Unity workloads.
+
+---
+
+## ✨ Features
+
+- ⚡ **High-resolution native timing in pure C** (WinAPI `QueryPerformanceCounter`)
+- 🧹 **Zero GC allocations during measurement**
+- 🔒 **Deterministic and low-overhead**
+- 🔥 **Suitable for micro-benchmarks and hot-path measurements**
+- ⚙️ **IL2CPP & Mono compatible**
+- 🧩 **Scoped measurement via `using`**
+- 🎞️ **Profile sampling for each scope**
+- 🔬 **Independent from Unity Profiler**
+
+
+---
+
+## 📦 Installation
+
+Via UPM: `https://github.com/HardCodeDev777/UltraTimerWindows.git?path=Unity`
+
+---
+
+## 💻 Usage
+
+**UltraTimerWindows** provides very elegant and simple API:
+
+---
+
+### 💡 Basic example of usage
+
+```csharp
+using UnityEngine;
+// Namespace
+using HardCodeDev.UltraTimerWindows.Runtime;
+
+public class TestTimer : MonoBehaviour
+{
+    // Timer instance
+    private UltraTimerWindows _timer;
+
+    private void Start() => _timer = new();
+    
+    private void Update()
+    {
+        using (_timer.Measure()) 
+        {
+          // Here you can call any methods you want to measure
+          HeavyMethod();
+        }
+
+        // See results in the console
+        Debug.Log($"Last elapsed: {_timer.State.lastElapsedMs} ms, " +
+            $"total elapsed: {_timer.State.totalElapsedMs} ms, " +
+            $"average: {_timer.State.averageMs} ms, " +
+            $"called: {_timer.State.countOfCalling} times");
+    }
+
+    private void HeavyMethod()
+    {
+        for (int i = 0; i < 100000; i++)
+        {
+            float x = Mathf.Sqrt(i);
+        }
+    }
+    
+    // Don't forget about disposing!
+    private void OnDestroy() => _timer?.Dispose();  
+}
+```
+
+---
+
+### 🎞️ Profile Sampling
+
+```csharp
+using (_timer.Measure("Name of Sample")) 
+{
+  // Here you can call any methods you want to measure
+  HeavyMethod();
+}
+```
+
+And then after running with enabled Profile you'll see:
+
+<img src="media/profilesampling.png" height="400">
+
+---
+
+### 🫡 Reset Timer
+
+```csharp
+using (_timer.Measure("Name of Sample")) HeavyMethod();
+
+if (_timer.State.countOfCalling == 1000) _timer.Reset();
+```
+
+Result:
+
+<img src="media/resettimer.png" height="400">
+
+---
+
+### That's it! Enjoy measuring your heavy stuff 😎
+
+---
+
+## 📄 License
+
+This project is licensed under the **MIT License**.
+See the [LICENSE.md](LICENSE.md) file for full terms.

README.md

@@ -4,14 +4,12 @@
   "displayName": "UltraTimerWindows",
   "license": "MIT",
   "licensesUrl": "https://github.com/HardCodeDev777/UltraTimerWindows/blob/main/LICENSE.md",
-  "documentationUrl": "https://github.com/HardCodeDev777/UltraTimerWindows/blob/master/README.md",
-  "description": "Ultra fast and high performance native timer for Unity using QueryPerformanceCounter from winapi",
+  "documentationUrl": "https://github.com/HardCodeDev777/UltraTimerWindows/blob/main/README.md",
+  "description": "Zero-allocation during measurement, native high-resolution timer for Unity, built on top of Windows QueryPerformanceCounter",
   "unity": "2021.3",
-  "type": "library",
   "keywords": [
     "performance",
     "native",
-    "benchmarks",
     "windows",
     "ultratimerwindows"
   ],