Skip to content

Commit e7e1bc6

Browse files
committed
Updated readme
1 parent 9bb1ad7 commit e7e1bc6

File tree

2 files changed

+21
-10
lines changed

2 files changed

+21
-10
lines changed

README.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,26 @@
1-
<p align="center">
2-
<h1>Pure JS lightbox component for Vue.js</h1>
3-
<a href="https://www.npmjs.com/package/vue-pure-lightbox"><img src="https://img.shields.io/npm/dt/vue-pure-lightbox.svg" alt="Downloads"></a>
4-
<a href="https://www.npmjs.com/package/vue-pure-lightbox"><img src="https://img.shields.io/npm/v/vue-pure-lightbox.svg" alt="Version"></a>
5-
<a href="https://spdx.org/licenses/MIT.html"><img src="https://img.shields.io/npm/l/vue-pure-lightbox.svg" alt="License"></a>
6-
</p>
1+
# Pure JS lightbox component for Vue.js
2+
<a href="https://www.npmjs.com/package/vue-pure-lightbox"><img src="https://img.shields.io/npm/dt/vue-pure-lightbox.svg" alt="Downloads"></a>
3+
<a href="https://www.npmjs.com/package/vue-pure-lightbox"><img src="https://img.shields.io/npm/v/vue-pure-lightbox.svg" alt="Version"></a>
4+
<a href="https://spdx.org/licenses/MIT.html"><img src="https://img.shields.io/npm/l/vue-pure-lightbox.svg" alt="License"></a>
5+
6+
## Table of contents
7+
* [Demo](#demo)
8+
* [Installation](#installation)
9+
* [With NPM](#with-npm)
10+
* [With a CDN](#with-a-cdn)
11+
* [Usage](#usage)
12+
* [With an ES6 bundler (via NPM)](#with-an-es6-bundler-via-npm)
13+
* [With a CDN](#with-a-cdn)
14+
* [Available props](#available-props)
15+
* [Contents](#contents)
16+
* [License](#license)
17+
* [Issues](#issues)
718

819
## Demo
920
The live demo is available here: [https://codepen.io/DCzajkowski/pen/rzOErW](https://codepen.io/DCzajkowski/pen/rzOErW).
1021

1122
## Installation
12-
### With npm:
23+
### With NPM:
1324
```bash
1425
npm i vue-pure-lightbox --save
1526
```
@@ -23,7 +34,7 @@ npm i vue-pure-lightbox --save
2334
```
2435

2536
## Usage
26-
### With an ES6 bundler (via npm)
37+
### With an ES6 bundler (via NPM)
2738
In your index file
2839
```js
2940
import Lightbox from 'vue-pure-lightbox'
@@ -76,5 +87,5 @@ CSS is being used in the component, but each class is prefixed with a `lightbox`
7687
## License
7788
Just use it. For free. Forever.
7889

79-
## Bugs
90+
## Issues
8091
If you find any bug or problem with the plugin please open an issue or create a pull request on the [Github repo](https://github.com/DCzajkowski/vue-lightbox).

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "vue-pure-lightbox",
3-
"version": "2.1.0",
3+
"version": "2.1.1",
44
"description": "Very lightweight, JavaScript-only, lightbox plugin for Vue.js",
55
"main": "dist-module/main.js",
66
"scripts": {

0 commit comments

Comments
 (0)