# Random Avatars

![GitHub repo size](https://img.shields.io/github/repo-size/luciferreeves/randomavatars?style=for-the-badge) ![GitHub](https://img.shields.io/github/license/luciferreeves/randomavatars?style=for-the-badge) 

[![GitHub followers](https://img.shields.io/github/followers/luciferreeves?&logo=github&style=for-the-badge)](https://www.github.com/luciferreeves) [![Twitter Follow](https://img.shields.io/twitter/follow/lucifercreeves?logo=twitter&style=for-the-badge)](https://www.twitter.com/LuciferCReeves)

<!-- ![npm bundle size](https://img.shields.io/bundlephobia/min/randomavatars?label=NPM%20BUNDLE%20SIZE&style=for-the-badge) ![npm](https://img.shields.io/npm/dw/randomavatars?style=for-the-badge) -->

The only NPM library which uses the [Robohash](https://github.com/e1ven/Robohash) algorithm by [Colin Davis](https://github.com/e1ven) — so go to his GitHub page and show some love.

## What this actually does?

It basically takes a string and returns an avatar for it. In the backgrounf it works the same as Robohash, i.e., it copy/pastes various pictures together, using bits from the SHA hash. Consider this a JavaScript translation of the actual Python based Robohash library.

## Usage Documentation

Coming soon.

## License

This project is available under the MIT license. See the [LICENSE.md](LICENSE) file for the full text of this license. Copyright (c) 2021, Priyansh.

## Credits

Credit is due to [Colin Davis](https://github.com/e1ven) for this awesome algoritm.

The avatar sets are the same sets used in the Robohash library, but I thought they deserve some credit here too.

- **Robots** (Set 1): artwork (and robohash backgrounds) were created by Zikri Kader. They are available under CC-BY-3.0 or CC-BY-4.0 license.
- **Monsters** (Set 2): artwork was created by Hrvoje Novakovic. They are available under CC-BY-3.0 license.
- **Heads** (Set 3): artwork was created by Julian Peter Arias. They are available under CC-BY-3.0 license.
- **Cats** (Set 4): created by David Revoy, used under CC-BY-4.0 ([Link](https://www.peppercarrot.com/en/article391/cat-avatar-generator)).
- **Humans** (Set 5): created by Pablo Stanley, for [Avataaars](https://avataaars.com/). They are "Free for personal and commercial use. 😇"