diff --git a/README b/README index de688277..9f8497e0 100644 --- a/README +++ b/README @@ -15,6 +15,11 @@ and is released under the GNU General Public Licence (GPL). The internationalization files may contain contributions by several people; they should be mentioned in each file individually. +== Prerequisites == +This version of Gadgets requires MediaWiki 1.17 or later. To get a version +compatible with earlier MediaWiki release, visit + http://www.mediawiki.org/wiki/Special:ExtensionDistributor/Gadgets + == Installing == Copy the Gadgets directory into the extensions folder of your MediaWiki installation. Then add the following lines to your @@ -34,6 +39,10 @@ Each line in MediaWiki:Gadgets-definition that start with one or more "*" (asterisk) characters defines a gadget; it must have the following form: * mygadget|mygadget.js|mygadget.css + +or + + * mygadget[ResourceLoader]|mygadget.js|mygadget.css That is, each line consists of fields separated by a "|" (pipe) character. The first field ("mygadget" in the example) is the gadgets internal name, @@ -44,6 +53,12 @@ contain only ASCII letter and numbers, hyphens ("-"), underscores ("_"), colons (":"), and periods (".") (spaces are also allowed but converted to underscores ("_"), like for page titles). +If the gadget name is followed by [ResourceLoader], its JavaScript will +be loaded concatenated, minified and gzipped by ResourceLoader, thus +improving load times. However, older gadgets may be incompatible with +ResourceLoader, so all JS is by default loaded the old way, using separate +