release: 1.1.0, includes update build icons process, improve quality of SVGs icons, prepare png icons in 128x128, fix web fonts, update documentation, update animation: icon animation has higher priority than common animation. (#28)

Closes #26

README.md

@@ -1,7 +1,7 @@
 <h1><img src="https://i.imgur.com/cXYo5bi.png"> Eva Icons</h1>
 <img src="https://i.imgur.com/oDmqDkE.jpg">
 
-**Eva Icons** is a pack of more than 480 beautifully crafted Open Source icons for common actions and items. Additionally Eva Icons supports 4 animation types: `zoom`, `pulse`, `shake` and `flip`.  Download on desktop to use them in your digital products for Web, iOS and Android. Icons are provided in two visual types: `Fill` and `Outline` and in serveral formats, including `PNG`, `SVG`, `font`, `Sketch`, etc.
+**Eva Icons** is a pack of more than 480 beautifully crafted Open Source icons for common actions and items. Additionally Eva Icons supports 4 animation types: `zoom`, `pulse`, `shake` and `flip`.  Download on desktop to use them in your digital products for Web, iOS and Android. Icons are provided in two visual types: `Fill` and `Outline` and in several formats, including `PNG`, `SVG`, `font`, `Sketch`, etc.
 
 ## Download
 - [Complete Eva Icons Package](https://akveo.github.io/eva-icons/eva-icons.zip)
@@ -67,6 +67,16 @@ import * as eva from 'eva-icons';
 ```
 *Thanks to Feather Icons for the build process inspiration.*
 
+- Additional attributes: 
+  * `data-eva-fill`: set icon color
+  * `data-eva-height`: set icon height
+  * `data-eva-width`: set icon width
+  * `data-eva-animation`: [set icon animation](#animation)
+  
+```html
+<i data-eva="github" data-eva-fill="#ff0000" data-eva-height="48" data-eva-width="48"></i>
+```
+
 ### Fonts
 
 Eva Icons are also available as a Web Font.
@@ -86,9 +96,60 @@ We recommend using SVG icons due to better rendering and performance capabilitie
 
 ## Documentation
 
-### `eva.replace({ ... })`
+### `eva.replace(options)`
+
+Replaces all elements that have a `data-eva` attribute with SVG markup.
+
+`options` optional object.
+
+#### Available 'option' properties:
+| Name |  Type   |  Default value | Description |
+|------| ------  | -------------  |-------------|
+| fill | string | none           | Icon color  |
+| width | string or number | 24px    | Icon width  |
+| height | string or number | 24px    | Icon height  |
+| class | string | none | Custom css class  |
+| animation | object | none    | [Icon animation](#animation)  |
+
+### Animation 
+- Add the `data-eva-animation` attribute with the animation type `(zoom, pulse, shake and flip)` to an element:
+
+```html
+<i data-eva="github" data-eva-animation="zoom"></i>
+```
+
+- Additional animation attributes:
+  * `data-eva-hover`: Makes the animation available on hover. Default value is `true`. Available true or false.
+  * `data-eva-infinite`: Makes the animation infinite. Default value is `false`. Available true or false.
+
+```html
+<i data-eva="github" data-eva-animation="zoom" data-eva-hover="false" data-eva-infinite="true"></i>
+```
+
+> **Note:** In the above example `github icon` will be always animated. This type of animation will be applied only to current icons.
+
+- Pass animation as property in a `eva.replace` method.
+
+```js
+eva.replace({
+  aniamtion: {
+    type: string, // zoom, pulse, shake, flip
+    hover: booleam, // default true
+    infinite: boolean, // default false
+  }
+});
+```
+> **Note:** The animation will be applied to all replaced elements.
+
+- Add `eva-parent-hover` class to the parent container in a case you want to activate the animation hovering on the parent element.
+
+```html
+<div class="eva-parent-hover">
+  <i data-eva="github" data-eva-animation="zoom"></i>
+  Zoom aniamtion
+</div>
+```
 
-Replaces all elements that have a `data-eva` attribute with SVG markup corresponding to the element's `data-eva` attribute value.
 ## License
 [MIT](LICENSE.txt) license.
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "eva-icons-landing",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "browserslist": [
     "> 1%",
     "last 2 versions",
@@ -65,6 +65,7 @@
     "cross-env": "^5.2.0",
     "css-loader": "^1.0.0",
     "fs-extra": "^7.0.0",
+    "globby": "^8.0.1",
     "gm": "^1.23.1",
     "html-minifier": "^3.5.20",
     "jasmine-core": "~2.99.1",