Git Product home page Git Product logo

avatars-api's Introduction

adorable-avatars

Build Status

What is it?

What are avatars?

Avatars are earthly creatures that serve as proxies for gods. In the web world, they just represent people, and they're usually small images.

Some use photographs of themselves as their avatar. Some people use caricatures of themselves. Others pick their favorite superhero. The sky's the limit.

What's an avatar service?

It answers the question "What is this user's avatar?" In this way, it provides a consistent representation of that user. Across all websites that use that service. Pretty cool, right?

But what if you haven't uploaded your image to that service? Then you get a really boring, gray silhouette.

So what's the Adorable Avatars service?

It's an interface to a better universe. With a simple route, your face will be filled with consistently-linked avatar glory!

Huh? Consistently-linked avatar glory?

Whenever you make a request to Adorable Avatars, using an identifier like "[email protected]," we give you an image for you to use on your page. Most importantly, it's the same image! Every. Single. Time.

Why would I use it?

What if you're developing a feature like member lists or profiles, but you don't have any images to use? Just give us your user's identifier and we'll give you their avatar image! That's it.

Already have avatars implemented in your application? Use Adorable Avatars as a fallback and get rid of those gray silhouettes!

How do I use it?

Here's a quick example in Haml:

.user
  %img.avatar(src="http://api.adorable.io/avatar/#{user.name}")

Requesting an Avatar

The most basic request is of the following form:

http://api.adorable.io/avatar/<identifier>

Where identifier is the unique identifier for your user (name, email, md5, etc.). This will serve the image in its default size.

To request an avatar with specific size, use the following form:

http://api.adorable.io/avatar/<size>/<identifier>

So, if you want your friend Bob's avatar, with a height and width of 200px, the URL would be:

http://api.adorable.io/avatar/200/bob

Contributing

Please read the contributors' guide

Open-source Contributors

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.