Skip to content

Commit

Permalink
Add git repository info in the package.json file, update doc for npm …
Browse files Browse the repository at this point in the history
…related things and for build and lint
  • Loading branch information
sylvaincombes committed Jun 9, 2016
1 parent 56b00ad commit 4dfbba9
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 1 deletion.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,14 @@ $('#myImageCompare').imagesCompare();

## Documentation

### Install via npm

You can get the project via npm too :

```sh
npm install jquery-images-compare
```

### Plugin settings

You can change plugin settings by passing an option object, example :
Expand Down Expand Up @@ -195,7 +203,28 @@ test.setValue(0, true);
// test.setValue(ratio, animate, duration, easing);
```

### Contribute

Clone the repository, then launch an :

```sh
npm install
```

To lint js and css use :

```sh
npm run lint
```


To build use :

```sh
npm run build
```

*Too look available scripts look at the scripts part in the package.json file*

## Contributors
- [@sylvaincombes](https://github.com/sylvaincombes) (Maintainer)
Expand Down
9 changes: 8 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "jquery-images-compare",
"version": "0.1.0",
"version": "0.1.1",
"description": "A jquery plugin for comparing two images",
"keywords": [
"jquery",
Expand All @@ -12,6 +12,13 @@
"after"
],
"main": "build/jquery.images-compare.js",
"repository": {
"type": "git",
"url": "git+https://github.com/sylvaincombes/jquery-images-compare.git"
},
"bugs": {
"url": "https://github.com/sylvaincombes/jquery-images-compare/issues"
},
"dependencies": {
"hammerjs": "^2.0.8",
"jquery": "^2.2.4"
Expand Down

0 comments on commit 4dfbba9

Please sign in to comment.