Improved documentation
This commit is contained in:
parent
aab1e4c57f
commit
07cd9be8bd
12
README.md
12
README.md
|
@ -5,8 +5,9 @@ modifications.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
* [x] Simple identicons
|
* [x] Symmetric identicons
|
||||||
* [ ] libravatar/sigil identicons
|
* [x] sigil identicons
|
||||||
|
* [ ] Asymmetric identicons
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
@ -14,6 +15,11 @@ The HTML reference can be generated with build_doc.sh, if doxygen is installed.
|
||||||
It is also available at [doc.schlomp.space/identiconpp/]
|
It is also available at [doc.schlomp.space/identiconpp/]
|
||||||
(https://doc.schlomp.space/identiconpp/classIdenticonpp.html).
|
(https://doc.schlomp.space/identiconpp/classIdenticonpp.html).
|
||||||
|
|
||||||
|
You need to generate hashes yourself, any hexadecimal string will do. Make sure
|
||||||
|
to use a safe hashing algorithm for sensitive data (**not MD5**). You can select
|
||||||
|
as many columns and rows as you like, but make sure you have enough entropy.
|
||||||
|
If something seems to be wrong, exceptions will be thrown.
|
||||||
|
|
||||||
### Example
|
### Example
|
||||||
|
|
||||||
```C++
|
```C++
|
||||||
|
@ -23,7 +29,7 @@ It is also available at [doc.schlomp.space/identiconpp/]
|
||||||
|
|
||||||
int main()
|
int main()
|
||||||
{
|
{
|
||||||
Identiconpp identicon(5, 5, Identiconpp::identicon_type::simple,
|
Identiconpp identicon(5, 5, Identiconpp::algorithm::ltr_symmetric,
|
||||||
"ffffff88", { "800000ff" });
|
"ffffff88", { "800000ff" });
|
||||||
Magick::Image img;
|
Magick::Image img;
|
||||||
img = identicon.generate("55502f40dc8b7c769880b10874abc9d0", 200);
|
img = identicon.generate("55502f40dc8b7c769880b10874abc9d0", 200);
|
||||||
|
|
Loading…
Reference in New Issue