From 73a570994df335752802886f1593874d14005fd1 Mon Sep 17 00:00:00 2001 From: Nick Ford Date: Sun, 27 Sep 2020 14:56:51 -0400 Subject: [PATCH] update docs, bump vue-freezeframe version --- README.md | 11 ++++++++++- packages/vue-freezeframe/README.md | 14 ++++++++++++-- packages/vue-freezeframe/package.json | 2 +- 3 files changed, 23 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index bdd6fae..c574072 100755 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ 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. +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: @@ -20,6 +20,15 @@ To get started using the TypeScript beta: npm install freezeframe@5.0.0-beta.1 ``` +```sh +npm install vue-freezeframe@5.0.0-beta.1 +``` + +```sh +# react typescript re-write coming soon +# npm install react-freezeframe@5.0.0-beta.1 +``` + ## 4.x Version 4+ is built with modern javascript in mind. It's transpiled with webpack/babel, so it should diff --git a/packages/vue-freezeframe/README.md b/packages/vue-freezeframe/README.md index 6dfb18a..0c324df 100644 --- a/packages/vue-freezeframe/README.md +++ b/packages/vue-freezeframe/README.md @@ -14,6 +14,18 @@ Codesandbox: https://codesandbox.io/s/vue-freezeframe-demo-jibmp +## TypeScript + +`vue-freezeframe` is now written 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. + +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 @@ -40,8 +52,6 @@ Vue.use(VueFreezeframe); ## Local-only usage -`vue-freezeframe` is now written in TypeScript. For more advanced use cases, take a look at the [demo](./src/App.vue), or take a look at the [types exported from Freezeframe](../freezeframe/types). - ```html