From 018ec698d62f960c38a34f180d5f27a600988c3e Mon Sep 17 00:00:00 2001
From: MeowcaTheoRange <58280776+MeowcaTheoRange@users.noreply.github.com>
Date: Tue, 9 Aug 2022 12:39:33 -0500
Subject: [PATCH] Add docs for tween_nokaboom.js

---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/README.md b/README.md
index 7a764da..60b55b1 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,19 @@ A tween library for Kaboom that allows easy usage of tweens. It also comes with
 ### `easingpackage.js`
 - **Requires** a JavaScript version that supports ES6 functionality
 - **Can be used with** Kaboom, any version
+## Differences between `tween.js` and `tween_nokaboom.js`
+
+### `tween.js`
+- Smaller file size, but depends heavily on Kaboom functions
+- Perfect for Kaboom games
+- Uses `onUpdate()`, `lerp()`, and `time()`
+
+### `tween_nokaboom.js`
+- Bigger file size, but not dependent on Kaboom at all
+- Uses `performance.now()`, a very precise and lightweight time getter function
+- Do not use while making a Kaboom game, it would be pointless! Use for normal JS Canvas games instead.
+- Uses `Window.requestAnimationFrame()`
+
 ## Documentation
 
 `tween()` - Creates a tween to animate properties of an object.
@@ -51,6 +64,7 @@ A tween library for Kaboom that allows easy usage of tweens. It also comes with
 - private `__NOOP: Function`
 
 ## Example
+`tween.js`
 ```js
 import { KBTween } from ".../tween.js";
 import { easings } from ".../easingpackage.js";
@@ -88,3 +102,21 @@ twnlib.tween(bean.color, [ "g", "r" ], {
 	type: tweentypes.PINGPONG
 });
 ```
+`tween_nokaboom.js`
+```html
+<p>Points: <span id="number">0</span></p>
+<script type="module" src="...js"></script>
+```
+```js
+import { KBTween } from ".../tween_nokaboom.js";
+import { easings } from ".../easingpackage.js";
+
+var twnlib = KBTween();
+
+twnlib.tween(document.getElementById("number"), ["innerHTML"], {
+	from: 0,
+	to: 1000,
+	time: 10,
+	type: twnlib.tweentypes.NORMAL
+})
+```