Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
asika32764 committed Apr 11, 2018
1 parent 653858d commit d01a010
Showing 1 changed file with 23 additions and 15 deletions.
38 changes: 23 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ A [Vue.js](http://vuejs.org/ "Vue.js") port of [Animate.css](https://github.com/

**This is modified version of: https://github.com/haydenbbickerton/vue-animate for Vue 2.0**

**Thanks [@pavels-hyuna](https://github.com/pavels-hyuna) for his SCSS version work.**

## Installation
#### HTML
Include the stylesheet:
Expand All @@ -26,25 +28,31 @@ Include the stylesheet:
```js
require('vue2-animate/dist/vue2-animate.min.css')
```
#### Less
```less
@import "<PATH_TO_SOURCE>/src/less/vue2-animate.less";
```

#### Sass/Scss
```scss
$animationDuration: 0.5s; // specify animation duration. Default value: 1s
@import "<PATH_TO_SOURCE>/src/sass/vue2-animate.scss";
```

```scss
$animationDuration: 0.5s; // specify animation duration. Default value: 1s
@import "<PATH_TO_SOURCE>/src/sass/vue2-animate.scss";
```

#### Less
```less
@import "<PATH_TO_SOURCE>/src/less/vue2-animate.less";
```

> **NOTE** LESS version is deprecated and no-longer maintained. Use SCSS version for your new project.
#### Building
```shell
git clone https://github.com/asika32764/vue2-animate.git
cd vue2-animate
npm install
npm run build #Compiled .css files go to the dist folder.
```
You are able to build sass version with command `npm run build-sass`.

```shell
git clone https://github.com/asika32764/vue2-animate.git
cd vue2-animate
npm install
npm run build #Compiled .css files go to the dist folder.
```

You are able to build LESS version with command `npm run build:less`.

## Usage

Expand Down

0 comments on commit d01a010

Please sign in to comment.