-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathreadme.txt
58 lines (34 loc) · 2.42 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
=== InstantClick ===
Contributors: Mike_Cowobo
Tags: performance, instantclick, links
Requires at least: 3.9
Tested up to: 3.9.1
Stable tag: 1.0.2
License: MIT
License URI: http://opensource.org/licenses/MIT
Dramatically speed up your WordPress site and make navigation effectively instant by loading the next link on hover.
== Description ==
InstantClick dramatically speeds up your website, making navigation effectively instant in most cases. This plugin is the easiest way of adding InstantClick to your WordPress theme.
> Before visitors click on a link, they hover over that link. Between these two events, 200 ms to 300 ms usually pass by ([test yourself here](http://instantclick.io/click-test)). InstantClick makes use of that time to preload the page, so that the page is already there when you click.
See [InstantClick.io](http://instantclick.io/) for more information on InstantClick.
This plugin simply adds InstantClick to your website using the WordPress scripts API. For further tweaking, see the [announcement post](http://cacheglove.com/2014/05/speed-up-your-wordpress-site-with-instantclick/).
== Installation ==
Install and activate the plugin. InstantClick should be automatically added to your website.
= Fine Tuning =
In WP-Admin you will find a new options page called 'InstantClick' under 'Settings'. On the options page you can:
* Set the preload mode (on hover with a 0, 50 or 100ms delay, or on mousedown)
* Exclude scripts from reloading with InstantClick (adding `data-no-instant`)
* Add custom JavaScript to be loaded before or after InstantClick has initialized
See the documentation on [InstantClick.io](http://instantclick.io/download) for details on how the script works and how to ensure compatibility with other scripts. To add the `data-no-instant` attribute to scripts, use the 'No-Instant Scripts' setting on the options page.
To add any custom JavaScript around the InstantClick initialization, use the script editor on the admin page.
== Frequently Asked Questions ==
None yet. Checkout the [support forum](http://wordpress.org/support/plugin/instantclick), the [GitHub repo](https://github.com/mgmartel/WP-InstantClick) and [InstantClick](http://instantclick.io) website for the answers to most questions.
== Screenshots ==
1. The InstantClick settings page
== Changelog ==
= 1.0.2 =
* PHP 5.2 compatibility
= 1.0.1 =
* Fix warning in script handle sanitation
= 1.0 =
* Initial release to WP.org plugin repository.