Skip to content

Commit

Permalink
Updating Readme file with npm instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
dfernandeza committed Jul 13, 2015
1 parent 1ca98e4 commit 8deab34
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 3 deletions.
7 changes: 6 additions & 1 deletion README.md
Expand Up @@ -20,10 +20,15 @@ Features

Getting Started
---------------
- Include the jQuery library and the PicTip plugin on your page. It can also be installed using [Bower](http://bower.io/):
- Include the jQuery library and the PicTip plugin on your page. It can also be installed using [Bower](http://bower.io/) or [npm](https://www.npmjs.com/package/pictip):
```
bower install jquery-pictip
```

```
npm install jquery-pictip
```

- Call the pictip() method on the jQuery element that contains your image(s).
Let me show you an example:

Expand Down
34 changes: 34 additions & 0 deletions bower.json
@@ -0,0 +1,34 @@
{
"name": "jquery-pictip",
"version": "1.1.0",
"homepage": "https://github.com/dfernandeza/pictip",
"authors": [
"Daniel Fernandez"
],
"description": "Add handy tooltips to your images, slideshows, sliders and more",
"main": "js/jquery.pictip.min.js",
"moduleType": [
"globals"
],
"keywords": [
"tooltip",
"slider",
"images",
"jquery-plugin",
"annotations",
"media",
"ecosystem:jquery"
],
"license": "MIT and GPL",
"ignore": [
"**/.*",
"node_modules",
"bower_components",
"test",
"tests"
],
"repository": {
"type": "git",
"url": "https://github.com/dfernandeza/pictip.git"
}
}
5 changes: 3 additions & 2 deletions package.json
@@ -1,5 +1,5 @@
{
"name": "pictip",
"name": "jquery-pictip",
"version": "1.1.0",
"description": "Add handy tooltips to your images, slideshows, sliders and more",
"main": "Gruntfile.js",
Expand All @@ -16,7 +16,8 @@
"images",
"jquery-plugin",
"annotations",
"media"
"media",
"ecosystem:jquery"
],
"author": "Daniel Fernandez",
"license": "MIT and GPL",
Expand Down

0 comments on commit 8deab34

Please sign in to comment.