diff --git a/README.md b/README.md index 88a052b..b265cc5 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ -> When Ajax navigation meets Push State +> Easily enable fast Ajax navigation on any website (using pushState + xhr) Pjax is ~~a jQuery plugin~~ **a standalone JavaScript module** that uses ajax (XmlHttpRequest) and @@ -10,7 +10,10 @@ ajax (XmlHttpRequest) and to deliver a fast browsing experience. _It allow you to completely transform user experience of standard websites -(server side generated or static ones) to make them feel they browse an app._ +(server side generated or static ones) to make them feel they browse an app. +Especially for user that have low bandwidth connection._ + +**No more full page reload. No more lots of HTTP request.** ## No tests or Demo ? @@ -223,7 +226,7 @@ Callbacks are binded to Pjax instance itself to allow you to reuse it (ex: `this ###### Create a switch callback -Your function can do whatever you want, be should +Your function can do whatever you want, but you need to: - replace oldEl content by newEl content in some fashion - call `this.onSwitch()` to trigger attached callback. @@ -274,7 +277,7 @@ new Pjax({ }) ``` _Note that remove class include `Animated--reverse` which is a simple way to not have -to create duplicate transition for (slideIn + reverse => slideOut). +to create duplicate transition for (slideIn + reverse => slideOut)._ The following CSS will be required to make something nice diff --git a/bower.json b/bower.json index d25854a..f65ca01 100644 --- a/bower.json +++ b/bower.json @@ -1,7 +1,7 @@ { "name": "pjax", "version": "0.1.2", - "description": "Boost browsing experience using Ajax navigation (+ Push state)", + "description": "Easily enable fast Ajax navigation on any website (using pushState + xhr)", "main": "src/pjax.js", "homepage": "https://github.com/MoOx/pjax", "authors": [ diff --git a/package.json b/package.json index 9e3a381..c526cf3 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "pjax", "version": "0.1.2", - "description": "Boost browsing experience using Ajax navigation (+ Push state)", + "description": "Easily enable fast Ajax navigation on any website (using pushState + xhr)", "main": "src/pjax.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1"