Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Cam O'Connell committed Dec 17, 2018
1 parent 3b9c0fa commit d4c7eca
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ A Modern JS library for SVG path animation

# Installation
NPM
```js
npm install lazy-line-painter
import LazyLinePainter from 'lazy-line-painter'
```
npm install lazy-line-painter
import LazyLinePainter from 'lazy-line-painter'
```

or download the latest release from - https://github.com/camoconnell/lazy-line-painter/releases
and include as script tag
```html
<script src="./libs/lazylinepainter-1.9.0.js"></script>
```
<script src="./libs/lazylinepainter-1.9.0.js"></script>
```
<br><br>

Expand All @@ -44,17 +44,16 @@ Create your Line art in your vector editor of choice

Pass lazylinepainter a config object as an argument containing the attritubes you wish to alter;

```js
let el = document.querySelector('#demo')
let myAnimation = new LazyLinePainter(el, config)
```
let el = document.querySelector('#demo')
let myAnimation = new LazyLinePainter(el, config)
```
<br>
All config properties are optional.
<br>
Style attributes set in the config will override css styles
<br>
```js

```
let config = {
// style properties
Expand All @@ -71,14 +70,15 @@ Style attributes set in the config will override css styles
'reverse' // reverse drawSequence
'ease' // penner easing
}
```

<br>

The following data attributes can be set to target individual shapes in the DOM. <br>
Data attributes will override both css styles & config style attributes

```js
```
<path
// style attribues
Expand Down

0 comments on commit d4c7eca

Please sign in to comment.