Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
giotiskl committed Feb 11, 2018
1 parent 92ac536 commit 6f4d145
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ If you use Filterizr in your project and wish to get it featured on Filterizr's
Filterizr is a jQuery plugin that sorts, shuffles, searches and applies stunning filters over responsive galleries using CSS3 transitions. Write your very own, custom effects in CSS and watch your gallery come to life!

## Install
You can install Filterizr by downloading the minified version on its website or through NPM or Yarn:
You can install Filterizr by downloading the minified version on its website/repo or through NPM/Yarn:
```
npm install filterizr
```
Expand All @@ -14,7 +14,18 @@ or
yarn add filterizr
```

Two files can be found in the `./dist/` directory:
* `jquery.filterizr.min.js` is only Filterizr (without jQuery in the bundle). If you choose to use this distribution you will have to make sure that jQuery is globally imported before Filterizr in your code.
* `jquery.filterizr-with-jquery.min.js` is a distribution of Filterizr with jQuery (v3.3.1) inside the bundle.

## Documentation & Tutorials
### Basic usage
If you are building a simple static website and you are already importing jQuery yourself, make sure to download the `/dist/jquery.filterizr.min.js` and simply import it after jQuery.

If you are importing Filterizr from `/node_modules`, Filterizr's default export provide you with the global jQuery object extended with the Filterizr plugin:
```import $ from 'filterizr'```

### Tutorials & Docs
You can find Filterizr's documentation as well as a series of tutorials on how to install and operate Filterizr on [the Filterizr website](http://yiotis.net/filterizr).

## Why Filterizr?
Expand Down

0 comments on commit 6f4d145

Please sign in to comment.