Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Sep 8, 2017
1 parent 5972e23 commit 389c129
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 2 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@
*~
*.log
node_modules
*.env
.DS_Store
package-lock.json
1 change: 1 addition & 0 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Get the structural similarity between two images.
The `ssim` result will be a value between `0` and `1`. The more similar the images are, the higher the value will be.

#### Params

- **String** `source`: The first image path (local path or url).
- **String** `target`: The second image path (local path or url).
- **Object** `options`: An object containing the following fields:
Expand Down
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->


[![img-ssim](http://i.imgur.com/tXlhphU.png)](#)

# img-ssim

[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Version](https://img.shields.io/npm/v/img-ssim.svg)](https://www.npmjs.com/package/img-ssim) [![Downloads](https://img.shields.io/npm/dt/img-ssim.svg)](https://www.npmjs.com/package/img-ssim)
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/img-ssim.svg)](https://www.npmjs.com/package/img-ssim) [![Downloads](https://img.shields.io/npm/dt/img-ssim.svg)](https://www.npmjs.com/package/img-ssim)

> Get the structural similarity between two images.
Expand Down Expand Up @@ -39,13 +41,15 @@ imgSSIM(
});
```



## :question: Get Help

There are few ways to get help:

1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help from me, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:


## :memo: Documentation
Expand All @@ -57,6 +61,7 @@ Get the structural similarity between two images.
The `ssim` result will be a value between `0` and `1`. The more similar the images are, the higher the value will be.

#### Params

- **String** `source`: The first image path (local path or url).
- **String** `target`: The second image path (local path or url).
- **Object** `options`: An object containing the following fields:
Expand All @@ -79,6 +84,7 @@ this takes time. You can integrate and use these projects in your applications *
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

- Starring and sharing the projects you like :rocket:
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
- [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
- **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`
Expand Down

0 comments on commit 389c129

Please sign in to comment.