add note to main readme, bump version

helloraee · Sep 7, 2020 · 7361ecc · 7361ecc
1 parent 4d15acc
commit 7361ecc
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -10,6 +10,16 @@ animate on mouse hover / mouse click / touch event, or triggered manually.
 
 http://ctrl-freaks.github.io/freezeframe.js/
 
+## 5.x TypeScript beta
+
+Freezeframe core is now built in TypeScript! The library will still support usage in JavaScript, but if your project uses TypeScript, you'll have access to Freezeframe's type definitions, improved input validation, and depending on your IDE/text editor, autocompletion/intellisense.
+
+To get started using the TypeScript beta:
+
+```sh
+npm install [email protected]
+```
+
 ## 4.x
 
 Version 4+ is built with modern javascript in mind. It's transpiled with webpack/babel, so it should

diff --git a/packages/freezeframe/package-lock.json b/packages/freezeframe/package-lock.json
diff --git a/packages/freezeframe/package.json b/packages/freezeframe/package.json
@@ -1,6 +1,6 @@
 {
   "name": "freezeframe",
-  "version": "5.0.0-beta.0",
+  "version": "5.0.0-beta.1",
   "description": "Freezeframe is a library that automatically pauses animated .gifs and enables them to start animation on mouse hover or click",
   "main": "./dist/freezeframe.min.js",
   "types": "./dist/src/index.d.js",