diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..bc4ceed --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# Random Avatars + +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.md) 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. 😇" |