Skip to content

Commit

Permalink
Update README for use with NPM
Browse files Browse the repository at this point in the history
  • Loading branch information
jsilvermist committed May 20, 2018
1 parent 7d5a727 commit a722d1e
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@ Silverlinkz Photo Gallery

A Polymer hash-route based photo gallery.

Note: Fullscreen won't work on `webcomponents.org`, but will work when not in a fullscreen limited iframe.
Note: Fullscreen won't work on `webcomponents.org` due to being inside of a fullscreen restricted iframe.

## Installation

```sh
bower install --save jsilvermist/sl-gallery
npm install --save @silverlinkz/sl-gallery
```

## Usage

Import the gallery:

```html
<link rel="import" href="bower_components/sl-gallery/sl-gallery.html">
```javascript
import '@silverlinkz/sl-gallery';
```

Create an `sl-gallery` element, and add `sl-gallery-image` elements for each image:
Expand Down

0 comments on commit a722d1e

Please sign in to comment.