Skip to content

Commit

Permalink
Complete README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vodkabears committed Apr 21, 2015
1 parent 0512d70 commit c586c40
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,11 @@ Or:
<script src="js/jquery.remodal.js"></script>
```

#### namespace
#### NAMESPACE

Base HTML class for your modals. CSS theme will need to be updated to reflect this.

#### defaults
#### DEFAULTS

Extends default settings.

Expand Down Expand Up @@ -179,11 +179,21 @@ Get the instance of the modal and call a method:
```js
var inst = $.remodal.lookup[$('[data-remodal-id=modal]').data('remodal')];

// open the modal
/**
* Open the modal window
*/
inst.open();

// close the modal
/**
* Close the modal window
*/
inst.close();

/**
* Get a current state of the modal
* @returns {'closed'|'closing'|'opened'|'opening'}
*/
inst.getState();
```

## License
Expand Down

0 comments on commit c586c40

Please sign in to comment.