-
Notifications
You must be signed in to change notification settings - Fork 8
/
README.md.hex
76 lines (57 loc) · 2.48 KB
/
README.md.hex
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# AlchemicAvatar
[](https://travis-ci.org/zhangsoledad/alchemic_avatar?branch=master)
[](http://inch-ci.org/github/zhangsoledad/alchemic_avatar)
Creating letter avatar from user's name(or any other strong / character).
>Inspired by [letter_avatar](https://github.com/ksz2k/letter_avatar).
## Examples
#### Google's Inbox Palette
## Installation
System requirements
```bash
$ sudo apt-get install -y imagemagick
```
Mac OS X
```bash
$ brew install imagemagick ghostscript
```
Add alchemic_avatar to your list of dependencies in `mix.exs`:
```
def deps do
[{:alchemic_avatar, "~> 0.1.0"}]
end
```
Ensure alchemic_avatar is started before your application:
```
def application do
[applications: [:alchemic_avatar]]
end
```
## Configuration
```
config :alchemic_avatar,
cache_base_path: "priv/static", # default is "priv/static"
colors_palette: :iwanthue, # default is :google
weight: 500, # default is 300
annotate_position: "-0+10" # default is -0+5
```
#### Color palette
We have two color palettes implemented: `iwanthue` and `google`.
Each of them have different colors, but the `iwanthue` also differently calculates the color for specified username.
The `google` selected will generate the same avatar for both, "Krzysiek" and "ksz2k" usernames given (both of them starts with letter "k"), but `iwanthue` will calculate it's md5 and then selects color, so there's huge chance that these usernames get different colors.
## Usage
```
AlchemicAvatar.generate 'ksz2k', 200
=> "public/system/alchemic_avatar/k/155_206_95/200.png"
```
### Way to support chinese hanzi
```bash
# Translate chinese hanzi to pinyin
# https://github.com/zhangsoledad/alchemic_pinyin
iex> Pinyin.from_string("龡龢龣龤龥癩")
"chui he jue xie yu la"
```