forked from ctrl-freaks/freezeframe.js
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
a30c86c
commit 5440c48
Showing
1 changed file
with
2 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. | ||
|