X-Git-Url: http://aleph1.co.uk/gitweb/?a=blobdiff_plain;f=web%2Fmodules%2Fcontrib%2Fsuperfish%2FREADME.txt;h=286021686185bcfb09ebb6141684819a4b57fc21;hb=eba34333e3c89f208d2f72fa91351ad019a71583;hp=e2ba5a4cde8eebd764b819887ced27998c1c8849;hpb=a2bd1bf0c2c1f1a17d188f4dc0726a45494cefae;p=yaffs-website

diff --git a/web/modules/contrib/superfish/README.txt b/web/modules/contrib/superfish/README.txt
index e2ba5a4cd..286021686 100644
--- a/web/modules/contrib/superfish/README.txt
+++ b/web/modules/contrib/superfish/README.txt
@@ -13,39 +13,49 @@ Requirement
 
 Installation instructions (composer)
 ------------------------------------
-1. Add the proper repository to your composer.json file
-    {
-      "type": "package",
-      "package": {
-        "name": "drupal-superfish/superfish",
-        "version": "2.0",
-        "type": "drupal-library",
-        "dist": {
-          "url": "https://github.com/mehrpadin/Superfish-for-Drupal/archive/2.x.zip",
-          "type": "zip"
+0. You can skip this step if you use the popular
+   https://github.com/drupal-composer/drupal-project.
+   Otherwise check that your composer.json file has directives to install
+   libraries in the libraries directory like this:
+
+    "require": {
+      "composer/installers": "^1.0",
+    },
+    "extra": {
+        "installer-paths": {
+            "web/libraries/{$name}": ["type:drupal-library"]
         }
-      }
     }
 
-2. Require the library
-   $ composer require drupal-superfish/superfish:2.0
+    This assumes that your drupal root resides in the "web" direectory.
+    If it is in another directory (e.g. "docroot"), change accordingly.
 
-3. Go to "Administer" -> "Modules" and enable the module.
+1. Require the module
+
+    $ composer require drupal/superfish
+
+   Composer will then put the module *and* its library into the right places.
+
+2. Go to "Administer" -> "Modules" and enable the module.
 
-4. Go to "Administer" -> "Structure" -> "Block layout" -> click a "Place block" button to add a Superfish block to a region.
+3. Go to "Administer" -> "Structure" -> "Block layout" -> click a "Place block"
+   button to add a Superfish block to a region.
 
 
 Installation instructions (manual)
 ----------------------------------
-1. Download and extract the Superfish library into the libraries directory (usually "sites/all/libraries").
+1. Download and extract the Superfish library into the libraries directory
+   (usually "DRUPAL_ROOT/libraries").
    Link: https://github.com/mehrpadin/Superfish-for-Drupal/zipball/2.x
 
-2. Download and extract the Superfish module into the modules directory (usually "/modules").
+2. Download and extract the Superfish module into the modules directory
+   (usually "DRUPAL_ROOT/modules").
    Link: http://drupal.org/project/superfish
 
 3. Go to "Administer" -> "Modules" and enable the module.
 
-4. Go to "Administer" -> "Structure" -> "Block layout" -> click a "Place block" button to add a Superfish block to a region.
+4. Go to "Administer" -> "Structure" -> "Block layout" -> click a "Place block"
+   button to add a Superfish block to a region.
 
 
 How to style
@@ -58,9 +68,11 @@ A) Utilise the "Default" style as reference.
 B) Always use a DOM inspector utility (such as Firebug).
 
 C) Set the "Menu delay" option in the block configuration to a very high number
-   such as 99999999 while creating your own CSS. This will give you enough time to work with sub-menus.
+   such as 99999999 while creating your own CSS. This will give you enough time
+   to work with sub-menus.
 
-C) If your theme supports the Superfish module, set the "Style" option in the block configuration to "None".
+C) If your theme supports the Superfish module, set the "Style" option in the
+   block configuration to "None".
 
 
 Support requests