Skip to content

Commit

Permalink
add package-lock.json to git
Browse files Browse the repository at this point in the history
  • Loading branch information
jmartsch committed Jan 18, 2021
1 parent fca4d63 commit 7e4bbe0
Show file tree
Hide file tree
Showing 2 changed files with 4,365 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ LazyframeAdvanced comes with brand-like themes for YouTube and other services.

### Why Advanced?

The original Lazyframe library seems abandoned and the original author does not respond to questions or pull requests anymore. As there are some services missing and we wanted to make some improvements, we created our own version.
The original Lazyframe library is good as it is.
But there are some services missing and it still uses the slow scroll event listener.
We wanted to make some improvements, so we created our own version.

## Installation Instructions
1. [Install](#install)
Expand All @@ -48,7 +50,7 @@ JavaScript ES6 imports
import lazyframe from 'lazyframeAdvanced';
```

Include JavaScript in html
Include the library directly

```html
<script src="dist/lazyframe.min.js"></script>
Expand Down Expand Up @@ -89,7 +91,7 @@ General options and corresponding defaults

```js
lazyframe(elements, {
apikey: undefined,
apikey: enterYourApiKeyHere,
debounce: 250,
lazyload: true,

Expand Down Expand Up @@ -142,7 +144,7 @@ Callback function with the thumbnail URL

### `data-vendor`

Attribute for theming lazyframe. Currently supported values are `youtube`, `vimeo` and `vine`.
Attribute for theming lazyframe. Currently supported values are `youtube` and `vimeo`.

### `data-title`

Expand Down Expand Up @@ -175,9 +177,9 @@ Set this to true if you want the resource to execute (for example video to play)
## Compile from source
* clone the github repo
* cd into the cloned directory
* run `npm install`
* make your changes in the script or the scss file
* run `npx webpack`
* copy scripts from dist folder
* run `npm run build` or `npx webpack`

## License

Expand Down
Loading

0 comments on commit 7e4bbe0

Please sign in to comment.