Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
Removed gulp file

Bumped version
  • Loading branch information
julienetie committed Apr 4, 2017
1 parent 0e895dc commit 94aaf68
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 101 deletions.
28 changes: 2 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,5 @@
![img](http://oi68.tinypic.com/33m0pbr.jpg)

```php
*** Important API Changes***
```
#### For:
- resizilla.js
- resizilla.es.js

version 0.7+ requires the Request-frame or an alternative requestAnimationFrame & cancelAnimationFrame polyfill.

If you need to use both Request-frame and Resizilla check out [4d](https://github.com/envidia/4d) which includes both libraries and weighs under 2kB gzipped.

- [4d](https://github.com/envidia/4d)
- [requestFrame](https://github.com/julienetie/request-frame)

#### For:
- resizilla.polyfilljs
- resizilla.polyfill.es.js

These distributions include the Request-frame polyfill.


## resizilla
### A Better Window Resize
Expand All @@ -38,11 +18,9 @@ ____
```
npm i resizilla --save
```
##### via bower
```
bower i resizilla
yarn add resizilla
```
##### via [src](https://github.com/julienetie/resizilla/tree/master/dist)
____
#### Usage:

Expand All @@ -67,8 +45,6 @@ or
- orientationChange: See below...


_For general use, use a moderate delay e.g. `incept: 200`_

____
#### Tested browsers:

Expand Down Expand Up @@ -108,7 +84,7 @@ The current example only needs to reveal the transition of the debounce to satis

#### So no element resize support?

Nope, and with good reason. Elements resize detection is a different paradigm, to detect changes that occur with elements checkout [getComputedStyle](https://developer.mozilla.org/en-US/docs/Web/API/Window/getComputedStyle), [transitionEnd](https://developer.mozilla.org/en-US/docs/Web/Events/transitionend) & [MutationObserver](https://developer.mozilla.org/en/docs/Web/API/MutationObserver).
To detect changes that occur with elements checkout [getComputedStyle](https://developer.mozilla.org/en-US/docs/Web/API/Window/getComputedStyle), [transitionEnd](https://developer.mozilla.org/en-US/docs/Web/Events/transitionend) & [MutationObserver](https://developer.mozilla.org/en/docs/Web/API/MutationObserver).

_(Original ASCII art by Mozilla)_

Expand Down
2 changes: 1 addition & 1 deletion dist/resizilla.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
vVVv vVVv ': |_| \_\___||___/_/___|_|_|_|\__,_| ''
*/
/*
Version: 0.8.0
Version: 0.8.1
Description: A Better Window Resize
Author: Julien Etienne
Repository: https://github.com/julienetie/resizilla
Expand Down
2 changes: 1 addition & 1 deletion dist/resizilla.umd.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
vVVv vVVv ': |_| \_\___||___/_/___|_|_|_|\__,_| ''
*/
/*
Version: 0.8.0
Version: 0.8.1
Description: A Better Window Resize
Author: Julien Etienne
Repository: https://github.com/julienetie/resizilla
Expand Down
69 changes: 0 additions & 69 deletions gulpfile.js

This file was deleted.

8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
{
"author": "Julien Etienne",
"name": "resizilla",
"description": "A Better Window Resize",
"main": "resizilla.js",
"main": "dist/resizilla.umd.js",
"jsnext:main": "dist/resizilla.es.js",
"directories": {
"example": "example"
},
"scripts": {
"test": "gulp",
"bump": "node ./bump.js",
"build": "rollup -c ./rollup/umd.js && rollup -c ./rollup/es.js",
"watch": "rollup -c ./rollup/umd.js -w"
Expand All @@ -25,7 +26,6 @@
"resize events",
"mobile resize"
],
"author": "Julien Etienne",
"license": "MIT",
"bugs": {
"url": "https://github.com/julienetie/resizilla/issues"
Expand All @@ -47,5 +47,5 @@
"set-animation-interval": "^0.0.2",
"volve": "^0.0.8"
},
"version": "0.8.0"
"version": "0.8.1"
}

0 comments on commit 94aaf68

Please sign in to comment.