Skip to content

Commit d9845a1

Browse files
committed
update readme, version number
1 parent 33a487c commit d9845a1

File tree

2 files changed

+33
-25
lines changed

2 files changed

+33
-25
lines changed

README.md

+32-24
Original file line numberDiff line numberDiff line change
@@ -3,38 +3,15 @@
33
Generate letter avatar from username.
44
>Shamelessly copied from [alchemic_avatar](https://github.com/zhangsoledad/alchemic_avatar) and slightly modified with this code sample originally written by [Sergio Tapia](https://tapia49.rssing.com/chan-5508682/all_p2.html#item35)
55
6-
## Examples
7-
8-
#### Google's Inbox Palette
9-
10-
<img src="https://cloud.githubusercontent.com/assets/5518/13031513/43eefa76-d30b-11e5-8f06-85f8eb2a4fb6.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031514/43ef6d8a-d30b-11e5-9fbc-38ae526b56b3.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031517/43f0da12-d30b-11e5-8fef-6c7daf235a54.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031515/43f0568c-d30b-11e5-95c5-1653361d4443.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031512/43eebcc8-d30b-11e5-9f95-0093bfadd182.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031516/43f0d0bc-d30b-11e5-8822-f01a6a138ff8.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031519/44382430-d30b-11e5-96e4-bcd7ce5eb155.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031518/44378d04-d30b-11e5-9400-55ff46b94cbe.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031521/443a03cc-d30b-11e5-8467-9592e9dbb2ae.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031523/443badc6-d30b-11e5-9d72-45613018cab4.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031520/44394e14-d30b-11e5-966c-2eada89295c9.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031522/443a71fe-d30b-11e5-88f4-37d1fd220abb.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031525/44752b1e-d30b-11e5-8290-ed8888055e64.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031524/4471cef6-d30b-11e5-9f4c-004f993dd27b.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031526/4475a990-d30b-11e5-8be3-c8f4482dee03.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031527/44772482-d30b-11e5-92f0-b9190c312d70.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031528/447804ce-d30b-11e5-8002-9424d5474ddb.png" width="60" />
11-
12-
#### I Want Hue
13-
14-
A palette generated from:
15-
16-
[iwanthue](https://medialab.github.io/iwanthue/)
17-
186
## Installation
19-
System requirements
20-
21-
```bash
22-
$ sudo apt-get install -y imagemagick
23-
```
24-
25-
Mac OS X
26-
27-
```bash
28-
$ brew install imagemagick ghostscript
29-
```
307

318
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
329
by adding `abatap` to your list of dependencies in `mix.exs`:
3310

3411
```elixir
3512
def deps do
3613
[
37-
{:abatap, "~> 0.1.0"}
14+
{:abatap, "~> 0.2.0"}
3815
]
3916
end
4017
```
@@ -43,3 +20,34 @@ Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_do
4320
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
4421
be found at <https://hexdocs.pm/abatap>.
4522

23+
## Examples
24+
```
25+
## default options
26+
# - palette: :google
27+
# - shape: :square
28+
# - size: 512
29+
# - padding: size * 0.546875
30+
31+
iex> Abatap.create_from_initials("John", "Doe")
32+
{:ok, "/var/folders/bq/v60646nd7370n3lffmgfh94r00016k/T/JD-google-1731556906832.png"}
33+
34+
iex> Abatap.create_from_initials("John", "Doe", palette: :google)
35+
{:ok, "/var/folders/bq/v60646nd7370n3lffmgfh94r00016k/T/JD-google-1731556436238.png"}
36+
37+
iex> Abatap.create_from_initials("John", "Doe", palette: :iwanthue, shape: :circle)
38+
{:ok, "/var/folders/bq/v60646nd7370n3lffmgfh94r00016k/T/JD-iwanthue-1731557222647.png"}
39+
40+
iex> Abatap.create_from_initials("John", "Doe", palette: :google, shape: :squircle, size: 1024, padding: 400)
41+
{:ok, "/var/folders/bq/v60646nd7370n3lffmgfh94r00016k/T/JD-google-1731556436238.png"}
42+
```
43+
44+
#### Google's Inbox Palette
45+
46+
<img src="https://cloud.githubusercontent.com/assets/5518/13031513/43eefa76-d30b-11e5-8f06-85f8eb2a4fb6.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031514/43ef6d8a-d30b-11e5-9fbc-38ae526b56b3.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031517/43f0da12-d30b-11e5-8fef-6c7daf235a54.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031515/43f0568c-d30b-11e5-95c5-1653361d4443.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031512/43eebcc8-d30b-11e5-9f95-0093bfadd182.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031516/43f0d0bc-d30b-11e5-8822-f01a6a138ff8.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031519/44382430-d30b-11e5-96e4-bcd7ce5eb155.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031518/44378d04-d30b-11e5-9400-55ff46b94cbe.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031521/443a03cc-d30b-11e5-8467-9592e9dbb2ae.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031523/443badc6-d30b-11e5-9d72-45613018cab4.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031520/44394e14-d30b-11e5-966c-2eada89295c9.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031522/443a71fe-d30b-11e5-88f4-37d1fd220abb.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031525/44752b1e-d30b-11e5-8290-ed8888055e64.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031524/4471cef6-d30b-11e5-9f4c-004f993dd27b.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031526/4475a990-d30b-11e5-8be3-c8f4482dee03.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031527/44772482-d30b-11e5-92f0-b9190c312d70.png" width="60" /> <img src="https://cloud.githubusercontent.com/assets/5518/13031528/447804ce-d30b-11e5-8002-9424d5474ddb.png" width="60" />
47+
48+
#### I Want Hue
49+
50+
A palette generated from:
51+
52+
[iwanthue](https://medialab.github.io/iwanthue/)
53+

mix.exs

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ defmodule Abatap.MixProject do
44
def project do
55
[
66
app: :abatap,
7-
version: "0.1.0",
7+
version: "0.2.0",
88
elixir: "~> 1.14",
99
start_permanent: Mix.env() == :prod,
1010
description: description(),

0 commit comments

Comments
 (0)