Skip to content

Commit

Permalink
Readme quick fix
Browse files Browse the repository at this point in the history
  • Loading branch information
alexk111 committed Nov 26, 2014
1 parent 59ac838 commit ef70ee9
Showing 1 changed file with 11 additions and 23 deletions.
34 changes: 11 additions & 23 deletions README.md
Expand Up @@ -47,48 +47,36 @@ SVG should have the following structure to be a valid icon set:
</svg>
```

## SVGMorpheus()
## Options

### SVGMorpheus()

```javascript
var myIcons = SVGMorpheus(DOM, iconId, duration, easing);

```

### DOM

Object/IFrame/SVG element containing an iconset. Can be a DOM element or element id.

### iconId

*Optional*. Id of an icon shown after initialization. Default: last icon in the icon set.
**DOM** Object/IFrame/SVG element containing an iconset. Can be a DOM element or element id.

### duration
**iconId** *Optional*. Id of an icon shown after initialization. Default: last icon in the icon set.

*Optional*. Set a default duration for transitions, in msec. Default: 1000.
**duration** *Optional*. Set a default duration for transitions, in msec. Default: 1000.

### easing
**easing** *Optional*. Set a default easing for transitions. Default: linear.

*Optional*. Set a default easing for transitions. Default: linear.


## to()
### to()

```javascript
myIcons.to(iconId, duration, easing);

```

#### iconId

Id of an icon to transition to.

#### duration

*Optional*. Set a duration for the transition, in msec.
**iconId** Id of an icon to transition to.

#### easing
**duration** *Optional*. Set a duration for the transition, in msec.

*Optional*. Set an easing for the transition.
**easing** *Optional*. Set an easing for the transition.


## Supported Easings
Expand Down

0 comments on commit ef70ee9

Please sign in to comment.