Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Timo Ernst committed Apr 9, 2015
1 parent 3bbec96 commit ed92a74
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,14 +75,19 @@ Available options (if not set, default will be used)
- **pagination** (Default: true) Swiper pagination
- **loop** (Default: false) Swiper loop
- **open** (Default: true) Open welcome screen on init
- **onOpened** (Default: none) Callback function when welcomescreen is opened
- **onClosed** (Default: none) Callback function when welcomescreen is closed

## API

The following methods are available on a welcomescreen instance

```javascript
welcomescreen.open(); // Open the screen
welcomescreen.close(); // Closes it
welcomescreen.open(); // Open the screen
welcomescreen.close(); // Closes it
welcomescreen.next(); // Go to next slide
welcomescreen.previous(); // Go to previous slide
welcomescreen.slideTo(i); // Go to slide with index i
```

## Credits
Expand Down

0 comments on commit ed92a74

Please sign in to comment.