avatar-me/README.md

Simple node module to retrieves a user avatar given an email or a user name Edit

![Avatar me logo](./assets/logo_avatar_me_npm_package_google_images.png)

Simple node module to retrieves a user avatar given an email or a user name from Google, gravatar or a default image.

**Changelog:** [Change all the changes to this project here](./CHANGELOG.md)

## How to use it?

```javascript
var avatarMe = require('avatar-me')

avatarMe.fetchAvatar('jorge@ferreiro.me', 'jorge', (err, avatar) => {
  if (err) console.log(err)
  console.log(avatar)
})
```

## Configuration? Yes, please!

### Basic configuration

```javascript
var avatarMe = require('avatar-me')

avatarMe.configure({
  defaultAvatar: 'mySuperAwesomeDefaultAvatar.png',
  defaultAvatarPath: 'http://my/super/awesome/path/to/default/images/'
})

avatarMe.fetchAvatar('jorge@ferreiro.me', 'jorge', (err, avatar) => {
  if (err) console.log(err)
  console.log(avatar)
})
```

### Cache configuration using Redis. No more extra api calls!

In **0.1.0** we have introduced support to cache results with Redis!
Just add redis to the avatar me config and it will create a new redis client.

```javascript
var avatarMe = require('./index.js')

avatarMe.configure({
  defaultAvatar: 'mySuperAwesomeDefaultAvatar.png',
  defaultAvatarPath: 'http://my/super/awesome/path/to/default/images/',
  cache: {
	  host: '127.0.0.1',
	  port: '6379'
  },
  shouldFetchGmail: false,
  shouldFetchGravatar: false
})

avatarMe.fetchAvatar('jorge@ferreiro.me', 'jorge', (err, avatar) => {
	console.log(err)
	console.log(avatar)
})
```

## Contribute!

* Bugs, Pull Requests or feature requests? Go here! [avatar-me Github repository](https://github.com/ferreiro/avatar-me/issues)
* Or... Send me an email jorge [AT] ferreiro [DOT] me