From ceceb04827dbd646e2e3989e80bf62b95df856c4 Mon Sep 17 00:00:00 2001 From: Hosein Date: Mon, 28 Aug 2017 19:56:22 +0430 Subject: [PATCH] Updates readme titles --- README.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 7c7d0d2..909bf8d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -#vue-animate +# vue-animate + *Cross-browser CSS3 animation library* [![Version](https://img.shields.io/npm/v/vue-animate.svg?style=flat-square)](https://www.npmjs.com/package/vue-animate) @@ -8,8 +9,8 @@ A [Vue.js](http://vuejs.org/ "Vue.js") port of [Animate.css](https://github.com/ - **[DEMO](http://luoye.pw/vue-animate-demo/)** (courtesy of [luoye-fe](https://github.com/luoye-fe)) -##Installation -####HTML +## Installation +#### HTML Include the stylesheet: ```html @@ -17,7 +18,7 @@ Include the stylesheet: ``` -####npm +#### npm If you're on webpack and using the [css-loader](https://github.com/webpack/css-loader "css loader"), you can use something like this: ```shell npm install --save vue-animate @@ -25,12 +26,12 @@ Include the stylesheet: ```js require('vue-animate/dist/vue-animate.min.css') ``` -####Less +#### Less ```less @import "/src/vue-animate.less"; ``` -####Building +#### Building ```shell git clone https://github.com/haydenbbickerton/vue-animate.git cd vue-animate @@ -38,7 +39,7 @@ Include the stylesheet: npm run build #Compiled .css files go to the dist folder ``` -##Usage +## Usage Use [Vue.js transitions](http://vuejs.org/guide/transitions.html "Vue.js Transitions") as you normally would, but for the transition name you will use one of [Animate.css animations](https://github.com/daneden/animate.css#basic-usage "animations") **removing** the ***In/Out*** from the name. @@ -48,7 +49,7 @@ Include the stylesheet: ``` enter/leave is already written in the stylesheet, so just remove *In/Out* from the name and you're golden. -####Custom Transition Classes +#### Custom Transition Classes As of 0.0.3, Animate.css's original classnames are supported on enter/leave transitions. So if you're going to use [Custom Transition Classes](http://vuejs.org/guide/transitions.html#Custom-Transition-Classes "Custom Transition Classes"), you can either add *-enter/-leave* to the classes: ```js @@ -66,17 +67,17 @@ Include the stylesheet: }) ``` -####Supported Animations +#### Supported Animations Not all [Animate.css animations](https://github.com/daneden/animate.css#basic-usage "animations") are supported at the moment. Here is a list of what's in vue-animate (aka - *what you can put in the transition="x"* attribute) as of right now: -#####Bounce +##### Bounce * `bounce` * `bounceDown` * `bounceLeft` * `bounceRight` * `bounceUp` -#####Fade +##### Fade * `fade` * `fadeDown` * `fadeDownBig` @@ -87,20 +88,20 @@ Include the stylesheet: * `fadeUp` * `fadeUpBig` -#####Rotate +##### Rotate * `rotate` * `rotateDownLeft` * `rotateDownRight` * `rotateUpLeft` * `rotateUpRight` -#####Slide +##### Slide * `slideDown` * `slideLeft` * `slideRight` * `slideUp` -#####Zoom +##### Zoom * `zoom` * `zoomDown` * `zoomLeft`