Skip to content

Commit b679800

Browse files
Reformat README
1 parent a5e5933 commit b679800

File tree

2 files changed

+56
-23
lines changed

2 files changed

+56
-23
lines changed

README.md

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# RoboHash
2+
3+
The source code for [RoboHash.org](https://robohash.org/).
4+
5+
It basically copy/pastes various robot pictures together, using bits from
6+
the SHA hash. It's not perfect, and not entirely secure, but it gives
7+
a good gut-check to "Hey, this SHA is wrong."
8+
9+
## Install
10+
11+
Just the library:
12+
13+
```bash
14+
$ pip install robohash
15+
```
16+
17+
Or if you also want the web frontend:
18+
19+
```bash
20+
$ pip install robohash[web]
21+
```
22+
23+
## Usage
24+
25+
```python
26+
from robohash import Robohash
27+
28+
hash = "whatever-hash-you-want"
29+
rh = Robohash(hash)
30+
rh.assemble(roboset='any')
31+
with open("path/to/new/file.png", "w") as f:
32+
rh.img.save(f, format="png")
33+
```
34+
35+
## Robosets
36+
37+
RoboHash comes with three image sets, named "set1", "set2", and "set3". Specify
38+
which set you want in the `assemble()` method. Alternatively, specify the string
39+
"any", and RoboHash will pick an image set for you, based on the provided hash.
40+
41+
The "set1" artwork was created by Zikri Kader. The "set2" artwork was created by
42+
Hrvoje Novakovic. The "set3" artwork was created by Julian Peter Arias.
43+
44+
## License
45+
46+
The Python Code is available under the MIT/Expat license. See the `LICENSE.txt`
47+
file for the full text of this license. Copyright (c) 2011, Colin Davis.
48+
49+
The RoboHash images are available under the CC-BY-3.0 license.
50+
51+
## Disclaimer
52+
53+
OK, I'll admit I'm a crappy programmer. Compounding this, I wrote this code
54+
initially to be internal-only. It's ugly, and could be a LOT nicer.
55+
56+
Sorry about that.

README.txt

-23
This file was deleted.

0 commit comments

Comments
 (0)