
CONTENTS OF THIS FILE
---------------------
 
 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Maintainers
 

INTRODUCTION
------------

This module provides drupal integration with BaguetteBox library and
'Baguette Box' formatter for core image field type.


REQUIREMENTS
------------

No other modules requirement for this module.
Only library download from the library
from https://github.com/feimosi/baguetteBox.js.


INSTALLATION
------------
=> Via Manual Mode:

 * Install as usual, see http://drupal.org/node/895232 for further information.
 * Download BaguetteBox library from https://github.com/feimosi/baguetteBox.js.
   Use exact same version as defined in baguettebox.libraries.yml file
 * Unzip the library and place files to libraries directory.
   The directory structure should be as follows:
   /libraries/baguettebox.js/dist/baguetteBox.min.css
   /libraries/baguettebox.js/dist/baguetteBox.min.js

=> Via Composer:

 * Add the following item to the "repositories" section of your composer.json:
     "repositories":
        {...},
        {
            "type": "package",
            "package": {
                "name": "feimosi/baguettebox.js",
                "version": "1.11.1",
                "type": "drupal-library",
                "dist": {
                    "url": "https://github.com/feimosi/baguetteBox.js/releases/download/v1.11.1/baguetteBox.js.zip",
                    "type": "zip"
                }
            }
        }

 * Download BaguetteBox library from https://github.com/feimosi/baguetteBox.js.
   Use exact same version as defined in baguettebox.libraries.yml file
 * Unzip the library and place files to libraries directory.
   The directory structure should be as follows:
   /libraries/baguettebox.js/dist/baguetteBox.min.css
   /libraries/baguettebox.js/dist/baguetteBox.min.js
 



CONFIGURATION
-------------

  * To configure this module, you need to create a
    new content type called "Baguette.box".
    After that, inside that content type, you need to create a field
    called "image" and change the format for "Baguete Box.

  * To make it work with Views, you should either set "Use field template"
    checkbox or manually add "baguettebox" class in View field style settings.


MAINTAINERS
-----------

Current maintainers:

* Ivan (Chi) - https://www.drupal.org/u/chi
* Elber Rodrigues (elber) - https://www.drupal.org/u/elber
