Skip to content

Commit

Permalink
Add npm & Bower to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kylefox committed Aug 17, 2015
1 parent 3040475 commit e35dd82
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,23 @@ and does so with as little HTML & CSS as possible.

# Installation

Include [jQuery](http:https://ajax.googleapis.com/ajax/libs/jquery/1/jquery.min.js) and `jquery.modal.min.js` scripts:
You can install [jquery-modal](https:https://www.npmjs.com/package/jquery-modal) with npm:

```html
<script src="jquery.min.js" type="text/javascript" charset="utf-8"></script>
<script src="jquery.modal.min.js" type="text/javascript" charset="utf-8"></script>
```
`npm install jquery-modal`

or with [Bower](http:https://bower.io/):

Include the `jquery.modal.css` default styles:
`bower install jquery-modal`

or the good old fashioned way of including the scripts & styles manually:

```html
<script src="jquery.modal.min.js" type="text/javascript" charset="utf-8"></script>
<link rel="stylesheet" href="jquery.modal.css" type="text/css" media="screen" />
```

_(You'll obviously need to include jQuery as well)._

**Using Rails?** Check out the [jquery-modal-rails plugin](https://github.com/dei79/jquery-modal-rails)!

**jQuery Requirements:** As of version 0.3.0, jQuery 1.7 is required. If you're using an earlier version of jQuery you can use the [v.0.2.5 tag.](https://github.com/kylefox/jquery-modal/tags)
Expand Down

0 comments on commit e35dd82

Please sign in to comment.