Skip to content

Commit

Permalink
update docs, bump vue-freezeframe version
Browse files Browse the repository at this point in the history
  • Loading branch information
nickforddev committed Sep 27, 2020
1 parent 27c426a commit 73a5709
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 4 deletions.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,23 @@ 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:

```sh
npm install [email protected]
```

```sh
npm install [email protected]
```

```sh
# react typescript re-write coming soon
# npm install [email protected]
```

## 4.x

Version 4+ is built with modern javascript in mind. It's transpiled with webpack/babel, so it should
Expand Down
14 changes: 12 additions & 2 deletions packages/vue-freezeframe/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected]
```

## Project setup

```bash
Expand All @@ -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
<template>
<vue-freezeframe src="./something.gif" />
Expand Down
2 changes: 1 addition & 1 deletion packages/vue-freezeframe/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "vue-freezeframe",
"version": "4.1.3",
"version": "v5.0.0-beta.1",
"main": "dist/vue-freezeframe.umd.js",
"repository": "https://github.com/ctrl-freaks/freezeframe.js",
"license": "MIT",
Expand Down

0 comments on commit 73a5709

Please sign in to comment.