Skip to content

Commit

Permalink
Add screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
neuhalje committed Sep 24, 2015
1 parent 4693e68 commit 1f2425f
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,20 @@ Robohash for Android!

This library creates recognizable images of cute robots from hash values (or basically any other data). It is a port of the source at [RoboHash.org](http:/RoboHash.org).

![Example robot 1](examples/robot1.png)
![Example robot 2](examples/robot2.png)
![Example robot 1](readme.d/robot1.png)

Usage
==========

Sometimes is necessary to create a _personality_ for data in your applications. A prime example are avatars for users that have no photo attached.

See the [example project](https://github.com/neuhalje/android-robohash-example).

Configuration
----------------

*Setup*
* Configure the allowed background sets
* Configure the allowed robot sets
* Configure the allowed colors (red, green, ...)

*Calculate the image*
* Pass in the hash of the data you want to 'personalize'. Get a stable (== you can persist it) handle
* Pass in the hash (or an uuid) of the data you want to 'personalize'. Get a stable (== you can persist it) handle

*Get an image*
* pass in the handle, and the desired resolution to get the image
Expand All @@ -29,6 +25,8 @@ Configuration
Example robots
-------------------

![Example robot 1](readme.d/robot1.png)
![Example robot 2](readme.d/robot2.png)

Contributors
==================
Expand All @@ -38,3 +36,8 @@ Contributors
* Set 3 artwork created by Julian Peter Arias.

The RoboHash images are available under the CC-BY-3.0 license.


Publish
=========
`./gradlew bintrayUpload`
Binary file added readme.d/robot1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme.d/robot2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1f2425f

Please sign in to comment.