README.txt

   1 CONTENTS OF THIS FILE
   2 ---------------------
   3  * Introduction
   4  * Requirements
   5  * Installation
   6  * Known Issues
   7  * Compatibility
   8  * Authors
   9  * Sponsors
  10
  11 INTRODUCTION
  12 ------------
  13
  14 The HeadJS module uses the head.js (http://headjs.com/) javascript library to dramatically improve javascript loading times by adding only one script to the document's head and then downloading individual script files in parallel.
  15
  16 Since downloading many small files at the same time is faster than downloading one big file, head.js makes pages load blazingly fast and is especially beneficial for certain mobile browsers who limit the size of individually cached javascript files.
  17
  18 For more information see: http://headjs.com/#theory
  19
  20
  21 REQUIREMENTS
  22 ------------
  23
  24 * head.js library (0.9+), version 0.96 recommended
  25
  26
  27 INSTALLATION
  28 ------------
  29
  30 1. Copy the headjs directory to your sites/all/modules or sites/all/modules/contrib directory.
  31
  32 2. * Download the head.js library from:
  33
  34      http://headjs.com/#download
  35
  36    * Extract the files to sites/all/libraries/headjs
  37
  38    * The actual head.js files should be located in:
  39
  40      /sites/all/libraries/headjs/head.min.js
  41
  42      and
  43
  44      /sites/all/libraries/headjs/head.load.min.js
  45
  46      OR
  47
  48      optionally, they could be placed in the "dist" subdirectory of headjs (for backwards compatibility & drush make friendlines)
  49
  50      /sites/all/libraries/headjs/dist/head.min.js
  51      /sites/all/libraries/headjs/dist/head.load.min.js
  52
  53 3. Enable the module at Administer >> Site building >> Modules.
  54
  55 4. Visit Administer >> Site Configuration >> Performance >> HeadJS to configure the module (optional)
  56
  57 5. That's it!
  58
  59
  60 USAGE
  61 ------
  62
  63 HeadJS is a plug-and-play module. Install it, adjust the settings if you want and forget about it. Add javascript normally using drupal_add_js(), add it to your theme's .info or even include it inline in your templates and HeadJS will detect it and replace it with the head.js version!
  64
  65
  66 KNOWN ISSUES
  67 ------------
  68
  69 None so far!
  70
  71 - Versions 6.x-1.0-beta2 and 6.x-1.0-beta3 required a patch to play nice with jquery_update. However, we managed to work around this and the patch is no longer necessary. We apologize if you patched your jquery_update and recommend that you undo the patch by re-installing jquery_update. (that said, the patch is harmless so I guess if you wanted you could just leave it there with no side-effects)
  72
  73
  74 SUPPORT
  75 -------
  76
  77 If you find a bug or have a feature request please file an issue: http://drupal.org/node/add/project-issue/headjs
  78
  79 COMPATIBILITY
  80 -------------
  81
  82 HeadJS has been tested and has found to work 100% with several contrib modules including but not limited to:
  83
  84   - jquery_update
  85   - jquery_ui
  86   - advagg
  87   - ctools
  88   - views
  89   - gmap
  90   - google_analytics
  91   - fbconnect
  92   - javascript_aggregator
  93   - boost
  94   - quicktabs
  95   - fivestar
  96   - disqus
  97   - views_slideshow
  98   - jcarousel
  99   - ckeditor
 100   - imce
 101   - wysiwyg
 102   - colorbox
 103   - fancybox
 104
 105
 106 AUTHORS
 107 --------
 108
 109 * Alex Weber (alexweber) - http://drupal.org/user/850856 & http://www.alexweber.com.br
 110 * Leandro Nunes (lnunesbr) - http://drupal.org/user/324393 & http://www.nunesweb.com
 111
 112
 113 SPONSORS
 114 ---------
 115
 116 This project is made possible by Webdrop (http://webdrop.net.br)
 117
 118 Webdrop is an up and coming Drupal shop based in S�o Paulo, Brazil. Try us for your next project!