Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nickforddev authored Jan 14, 2021
1 parent a30c86c commit 5440c48
Showing 1 changed file with 2 additions and 10 deletions.
12 changes: 2 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,22 +40,14 @@ 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).

## Packages
## Packages / Documentation

This is a [lerna.js](https://lerna.js.org/) monorepo, containing the following packages:
This is a [lerna.js](https://lerna.js.org/) monorepo, containing the following packages, each with their own docs:

- [freezeframe](./packages/freezeframe)
- [vue-freezeframe](./packages/vue-freezeframe)
- [react-freezeframe](./packages/react-freezeframe)

## Documentation

To get started with freezeframe, head over to the core [freezeframe](./packages/freezeframe) package.

To use freezeframe with Vue.js, check out the [vue-freezeframe](./packages/vue-freezeframe) docs.

React users should give [react-freezeframe](./packages/react-freezeframe) a try.

## How it works

For the curious, we are able to pause animated gifs by writing their data to a canvas element. Only the first frame of the animation can be written to the canvas, so we now have a frozen version of the gif.
Expand Down

0 comments on commit 5440c48

Please sign in to comment.