ekrenzin / node-identicon

Identicon Generator on Node.js

node-identicon

Identicon generator for Node.js

Installation

$ npm install identicon

Installing dependencies

If your project already uses 'canvas' it will use that. Otherwise, it will use canvas-prebuilt.

For more information, check the node-canvas Wiki.

## Ubuntu or Debian
sudo apt-get install build-essential libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev

## RHEL or CentOS
sudo yum install gcc-c++ cairo-devel pango-devel libjpeg-turbo-devel giflib-devel

## Mac
brew install pkg-config cairo pango libpng jpeg giflib librsvg

## Windows
## https://github.com/Automattic/node-canvas/wiki/Installation:-Windows

In Node.js

const identicon = require('identicon')
const fs = require('fs')

// Asynchronous API
identicon.generate({ id: 'ajido', size: 150 }, (err, buffer) => {
    if (err) throw err

    // buffer is identicon in PNG format.
    fs.writeFileSync(__dirname + '/identicon.png', buffer)
});

// Synchronous API
const buffer = identicon.generateSync({ id: 'ajido', size: 40 })

In the Browser

Vanilla JavaScript

<script type="text/javascript" src="dist/identicon.js"></script>

<div id='identicon'></div>

<script type="text/javascript">
  identicon.generate({ id: 'ajido', size: 150 }, function(err, buffer) {
      if (err) throw err;

      var img = new Image();
      img.src = buffer;
      document.getElementById('identicon').appendChild(img);
  });
</script>

Webpack / Browserify

const identicon = require('identicon')

identicon.generate({ id: 'ajido', size: 150 }, (err, buffer) => {
    if (err) throw err
    const img = new Image()
    img.src = buffer
    document.getElementById('identicon').appendChild(img)
})

License

(The MIT License)

Copyright (c) 2010-2012 Daiki Kuriyama <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.