diff --git a/README.md b/README.md index 54b9eb3..6c292a3 100755 --- 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 freezeframe@5.0.0-beta.1 +npm install freezeframe@5.0.0 ``` ```sh -npm install vue-freezeframe@5.0.0-beta.1 +npm install vue-freezeframe@5.0.0 ``` ```sh -npm install react-freezeframe@5.0.0-beta.1 +npm install react-freezeframe@5.0.0 ``` -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 freezeframe@4.1.3 +``` + 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 index f925cc0..19578a8 100755 --- 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 freezeframe@5.0.0-beta.1 -``` - - [Freezeframe.js](#freezeframejs) - [TypeScript](#typescript) - [Examples](#examples) diff --git a/packages/vue-freezeframe/README.md b/packages/vue-freezeframe/README.md index 8074853..2bae24e 100644 --- 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 vue-freezeframe@5.0.0-beta.1 -``` - ## Project setup ```bash