From ebe0ef2487d23918a53756bba6de130fa36027bd Mon Sep 17 00:00:00 2001
From: DashyFox <82226910+DashyFox@users.noreply.github.com>
Date: Mon, 4 Mar 2024 09:47:22 +0300
Subject: [PATCH] Create README.md

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fb42052
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+Позволяет анимировать числовой параметр, работает используя вычисления с плавающей точкой
+
+```fps``` - время пересчёта значения в колличестве раз в секунду<br/>
+```val``` - значение<br/>
+```startVal```, ```endTime``` - начальное/конечное значения<br/>
+```duration``` - длительность<br/>
+```EasingFunc::easeOutCirc``` - функция изинга из файла ```Easing.h```<br/>
+
+```c++
+Tween anim(fps); // 
+uint8_t val = 0;
+
+void loop() {
+    if(!anim.isPlaying()) {
+        anim.start(startVal, endTime, duration, EasingFunc::easeOutCirc);
+    } else {
+        val = anim.current; 
+    }
+}
+```