update docs for v5 release

helloraee · Jan 10, 2021 · 6bf4a33 · 6bf4a33
1 parent 87aad93
commit 6bf4a33
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -10,27 +10,33 @@ animate on mouse hover / mouse click / touch event, or triggered manually.
 
 http://ctrl-freaks.github.io/freezeframe.js/
 
-## 5.0 - TypeScript
+## v5 - TypeScript
 
 Freezeframe is now built entirely 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:
+To get started using freezeframe 5:
 
 ```sh
-npm install [email protected]-beta.1
+npm install [email protected]
 ```
 
 ```sh
-npm install [email protected]-beta.1
+npm install [email protected]
 ```
 
 ```sh
-npm install [email protected]-beta.1
+npm install [email protected]
 ```
 
-Version 5+ is built with modern JavaScript in mind. It's transpiled from TypeScript to normal JavaScript, and it should
+Version 5+ is built with modern development in mind. It's transpiled from TypeScript to JavaScript, and it should
 work in all modern browsers, but we are no longer supporting older browsers, or the jquery plugin.
 
+If you need to support older browsers, try v4.x:
+
+```sh
+npm install [email protected]
+```
+
 If you want to use freezeframe as a jquery plugin, check out
 [freezeframe v3.0.10](https://github.com/ctrl-freaks/freezeframe.js/tree/archived/3.0.10).
 

diff --git a/packages/freezeframe/README.md b/packages/freezeframe/README.md
@@ -15,12 +15,6 @@ plugin, check out [freezeframe v3.0.10](https://github.com/ctrl-freaks/freezefra
 
 Freezeframe 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]
-```
-
 - [Freezeframe.js](#freezeframejs)
   - [TypeScript](#typescript)
   - [Examples](#examples)

diff --git a/packages/vue-freezeframe/README.md b/packages/vue-freezeframe/README.md
@@ -20,12 +20,6 @@ https://codesandbox.io/s/vue-freezeframe-demo-jibmp
 
 For advanced use cases, take a look at the [demo source](./src/App.vue), or take a look at the [types exported from Freezeframe](../freezeframe/types).
 
-To get started using the TypeScript beta:
-
-```sh
-npm install [email protected]
-```
-
 ## Project setup
 
 ```bash