pcvolkmer/idicon
1
0
Fork 0
mirror of https://github.com/pcvolkmer/idicon.git synced 2025-04-19 16:46:50 +00:00
Code Issues Packages Releases Wiki Activity

Update README.adoc and include example identicons

Browse Source
This commit is contained in:
Paul-Christian Volkmer 2024-05-05 19:17:24 +02:00
parent cfa21df122
commit 98d85ed9ae
1 changed files with 28 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.adoc
View File

@ -6,8 +6,8 @@ Simple implementation of an identicon service.
=== Start application === Start application
The application takes two optional arguments to specify the location of the config file and the port the application The application takes two optional arguments to specify the location of the config file and the port the application is listening.
is listening. The following example shows the default values used if no arguments used. The following example shows the default values used if no arguments used.
.... ....
$ idicon -c /etc/idicon/config.toml -p 8000 $ idicon -c /etc/idicon/config.toml -p 8000
@ -21,15 +21,33 @@ HTTP `GET` is used to request an identicon image.
curl http://localhost:8000/avatar/23463b99b62a72f26ed677cc556c44e8?s=100&c=v2 curl http://localhost:8000/avatar/23463b99b62a72f26ed677cc556c44e8?s=100&c=v2
.... ....
Instead of requesting identicons for MD5 hashes of usernames or mail addresses, it is possible to use plain username and mail address. This will result in the same generated identicon. Instead of requesting identicons for MD5 hashes of usernames or mail addresses, it is possible to use plain username and mail address.
This will result in the same generated identicon.
Use request query parameter `s` to request images with specified size. Default value is 80px. The size is limited to a maximum value of 512px. Use request query parameter `s` or `size` to request images with specified size.
Default value is 80px.
The size is limited to a maximum value of 512px.
Query parameter `c` will set color scheme. Available values are `v1`, `v2` and `gh`. Query parameter `c` will set color scheme.
Available values are `v1`, `v2` and `gh`.
The latter resembles the color scheme used by GitHub. The latter resembles the color scheme used by GitHub.
The request query parameter `d` can be used to request GitHub like patterns by setting the value to `github`. The request query parameter `d` can be used to request GitHub like patterns by setting the value to `github`.
==== Examples
Some examples for `/avatar/example` and different params.
|===
| ..?c=v1 | ..?c=v2 | ..?c=v2&s=40 | ..?c=gh&d=gh
a|image::testdata/1a79a4d60de6718e8e5b326e338ae533_v1.png[]
a|image::testdata/1a79a4d60de6718e8e5b326e338ae533_v2.png[]
a|image::testdata/1a79a4d60de6718e8e5b326e338ae533_s40.png[]
a|image::testdata/1a79a4d60de6718e8e5b326e338ae533_gh.png[]
|===
=== Configuration === Configuration
Configuration is available by using a config file or by using environment variables. Configuration is available by using a config file or by using environment variables.
@ -39,6 +57,7 @@ Configuration is available by using a config file or by using environment variab
If config file `/etc/identicon/config.toml` exists, its configuration will be used on application start. If config file `/etc/identicon/config.toml` exists, its configuration will be used on application start.
Use application argument `-c` to use another file. Use application argument `-c` to use another file.
.... ....
$ identicon -c ./config.toml $ identicon -c ./config.toml
.... ....
@ -61,11 +80,13 @@ pattern = "github" # The pattern to be used for this user
User specific settings in config file will override any default settings or request params. User specific settings in config file will override any default settings or request params.
If config file is not present, the application will ignore it. Using environment variables will override default settings. If config file is not present, the application will ignore it.
Using environment variables will override default settings.
==== Environment Variables ==== Environment Variables
You can use `COLORSCHEME` to define the default color scheme to be used. Fallback value will be `v2`. You can use `COLORSCHEME` to define the default color scheme to be used.
Fallback value will be `v2`.
The `PATTERN` environment variable is available to define GitHub like patterns as default by using `github`. The `PATTERN` environment variable is available to define GitHub like patterns as default by using `github`.