From eb90b5dc987d9e58d3a0803c5f898b3d5eae031c Mon Sep 17 00:00:00 2001 From: Julien Etienne Date: Tue, 11 Oct 2016 00:37:29 +0100 Subject: [PATCH 1/2] Updated readme --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index cdb05cd..c31ae9c 100755 --- a/README.md +++ b/README.md @@ -12,9 +12,9 @@ #### Install options -`npm i request-frame --save` **  |  ** `bower i request-frame` **  |  ** [src](https://github.com/julienetie/request-frame/tree/master/dist) **  |  ** [release](https://github.com/julienetie/request-frame/releases) +`npm i request-frame --save` **  |  ** `bower i request-frame` **  |  ** [src](https://github.com/julienetie/request-frame/tree/master/dist) **  |  ** [release](https://github.com/julienetie/request-frame/releases) + - ```javascript import requestFrame from 'request-frame'; // ES6 ``` @@ -26,7 +26,7 @@ import requestFrame from 'request-frame'; // ES6 ```javascript const requestFrame = require('request-frame'); // CJS ``` - + ### The API: #### Assign the timing functions: @@ -54,22 +54,22 @@ function something( useTimeStamp ){ requestId = request(something); // Assigns Id & calls "something" ``` + #### Cancel something: + ```javascript cancel(requestId); // Cancels frame request ``` ### The ideology -request-frame aims to provide an optimal development consistency with the use of animation timing functions across the large number of browsers and devices. This lib is ideal for those who may want to avoid re-assigning native functions, or avoid interfering with other libs that do. requestFrame() is purposely not a constructor. The intention is for requestAnimationFrame to be used once or few times during execution since **multiple task are expected to be more efficient via a single requestAnimationFrame loop compared to several instances**. +request-frame aims to provide an optimal development consistency with the use of animation timing functions across the large number of browsers and devices. This lib is ideal for those who may want to avoid re-assigning native functions, or avoid interfering with other libs that do. requestFrame() is purposely not a constructor. The intention is for requestAnimationFrame to be used once or few times during execution since multiple task are expected to be more efficient via a single requestAnimationFrame loop compared to several instances. ### Browsers tested & passing: Supports everything from IE5+ - - ### Contribute Just do it! @@ -84,7 +84,7 @@ To launch port 9999 - ./test/compatibility-native-amd.html - ./test/compatibility-native.html -_Browser based testing for RAF is imperative_ +_Browser based testing for RAF is imperative_ ### Credits From 0654a264c945a6b4056adf8e11e860cf8e4b9618 Mon Sep 17 00:00:00 2001 From: Julien Etienne Date: Tue, 11 Oct 2016 00:40:38 +0100 Subject: [PATCH 2/2] Updated readme --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c31ae9c..bc226d0 100755 --- a/README.md +++ b/README.md @@ -68,8 +68,11 @@ request-frame aims to provide an optimal development consistency with the use of Supports everything from IE5+ - - +[](http://i61.tinypic.com/i1xuzd.jpg) + +[](http://i57.tinypic.com/j7fg2x.jpg) + + ### Contribute Just do it!