Skip to content

Commit

Permalink
Update docs to reflect that hash is no longer optional (#36)
Browse files Browse the repository at this point in the history
  • Loading branch information
stewartlord authored May 1, 2017
1 parent 7961557 commit 79591e9
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 8 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ npm install identicon.js --save

Options
----
* **hash** - [Optional] A hexadecimal string of 15+ characters that will be used to generate the image. Defaults to a random hash based on the current time.
* **hash** - A hexadecimal string of 15+ characters that will be used to generate the image.
* **options** - [Optional] An options object used to customize the generated image.
* **foreground** - The foreground color is automatically derived from the hash value. Use this option to override that behavior and provide a rgba value array instead (e.g. [255,0,0,255] for red).
* **background** - The background color expressed as an rgba value array to use for the image background. For example, use [255,0,0,255] for red. Defaults to an opaque light gray [240,240,240,255].
Expand Down
2 changes: 1 addition & 1 deletion bower.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"pnglib.js",
"identicon.js"
],
"version": "2.2.0",
"version": "2.2.1",
"homepage": "https://github.com/stewartlord/identicon.js",
"authors": [
"stewartlord"
Expand Down
2 changes: 1 addition & 1 deletion identicon.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* Identicon.js 2.2.0
* Identicon.js 2.2.1
* http://github.com/stewartlord/identicon.js
*
* PNGLib required for PNG output
Expand Down
7 changes: 2 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "identicon.js",
"version": "2.2.0",
"version": "2.2.1",
"description": "GitHub-style identicons as PNGs or SVGs in JS.",
"main": "identicon.js",
"repository": {
Expand All @@ -15,8 +15,5 @@
"bugs": {
"url": "https://github.com/stewartlord/identicon.js/issues"
},
"homepage": "https://github.com/stewartlord/identicon.js",
"devDependencies": {
"gulp": "^3.9.0"
}
"homepage": "https://github.com/stewartlord/identicon.js"
}

0 comments on commit 79591e9

Please sign in to comment.