Skip to content

Commit

Permalink
Docs: Add badges and remove hard-coded NPM version from files
Browse files Browse the repository at this point in the history
- Prepare for `npm version` command.
- bower.json will be updated manually if needed.
  • Loading branch information
vladimirsiljkovic committed Dec 10, 2018
1 parent 53ba291 commit 36a64d5
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 4 deletions.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,23 @@

jQuery plugin for responsive and accessible modal windows and tooltips.

[![NPM version](https://img.shields.io/npm/v/jquery-popup-overlay.svg?style=flat)](https://www.npmjs.com/package/jquery-popup-overlay)
[![NPM dependencies](https://img.shields.io/david/vast-engineering/jquery-popup-overlay.svg?style=flat)](https://david-dm.org/vast-engineering/jquery-popup-overlay)
[![NPM dev dependencies](https://img.shields.io/david/dev/vast-engineering/jquery-popup-overlay.svg?style=flat)](https://david-dm.org/vast-engineering/jquery-popup-overlay?type=dev)
<!-- [![NPM dev dependencies](https://david-dm.org/vast-engineering/jquery-popup-overlay/dev-status.svg)](https://www.npmjs.com/package/jquery-popup-overlay) -->
<!-- [![Downloads](https://img.shields.io/npm/dw/jquery-popup-overlay.svg?style=flat)](https://www.npmjs.com/package/jquery-popup-overlay) -->
<!-- [![GitHub stars](https://img.shields.io/github/stars/vast-engineering/jquery-popup-overlay.svg?label=Stars&style=flat)](https://github.com/vast-engineering/jquery-popup-overlay) -->

## Documentation & demo
[Documentation & demo](http://vast-engineering.github.io/jquery-popup-overlay/)

## License
Released under the [MIT license](http://www.opensource.org/licenses/MIT).
Released under the [MIT license](http://www.opensource.org/licenses/MIT).


<!-- [![build status][travis-image]][travis-url] -->
<!-- [![Build status][appveyor-image]][appveyor-url] -->
<!-- [travis-image]: https://img.shields.io/travis/jquery-popup-overlay/jquery-popup-overlay/gh-pages.svg?style=flat -->
<!-- [travis-url]: https://travis-ci.org/jquery-popup-overlay/jquery-popup-overlay -->
<!-- [appveyor-image]: https://ci.appveyor.com/api/projects/status/iwxmiobcvbw3b0av/branch/gh-pages?svg=true -->
<!-- [appveyor-url]: https://ci.appveyor.com/project/jquery-popup-overlay/jquery-popup-overlay/branch/gh-pages -->
4 changes: 2 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ <h1>jQuery Popup Overlay</h1>
<a href="https://github.com/vast-engineering/jquery-popup-overlay/archive/gh-pages.zip" class="btn btn-primary btn-success btn-lg"><span class="fa-download"></span> Download</a>
<a href="https://github.com/vast-engineering/jquery-popup-overlay" class="btn btn-lg btn-default"><span class="fa-github"></span> View project on GitHub</a>
</p>
<p class="text-muted">Currently v2.0.0</p>
<p class="text-muted"><a href="https://www.npmjs.com/package/jquery-popup-overlay"><img alt="NPM version" src="https://img.shields.io/npm/v/jquery-popup-overlay.svg?style=flat-square&label=Currently&colorA=transparent&colorB=transparent"></a></p>
</div>
</div>
</div>
Expand Down Expand Up @@ -151,7 +151,7 @@ <h2>Usage</h2>
&lt;script src="https://code.jquery.com/jquery-1.8.2.min.js"&gt;&lt;/script&gt;

&lt;!-- Include jQuery Popup Overlay --&gt;
&lt;script src="https://cdn.rawgit.com/vast-engineering/jquery-popup-overlay/2.0.0/jquery.popupoverlay.js"&gt;&lt;/script&gt;
&lt;script src="https://cdn.rawgit.com/vast-engineering/jquery-popup-overlay/gh-pages/jquery.popupoverlay.js"&gt;&lt;/script&gt;

&lt;script&gt;
$(document).ready(function() {
Expand Down
1 change: 0 additions & 1 deletion jquery.popupoverlay.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
/*!
* jQuery Popup Overlay
*
* @version 2.0.0
* @requires jQuery v1.7.1+
* @link http://vast-engineering.github.com/jquery-popup-overlay/
*/
Expand Down

0 comments on commit 36a64d5

Please sign in to comment.