Improved documentation, added images.
the build was successful Details

This commit is contained in:
tastytea 2018-12-28 01:57:08 +01:00
parent 211b0ba7b4
commit dc6e32fbf9
Signed by: tastytea
GPG Key ID: CFC39497F1B26E07
2 changed files with 20 additions and 0 deletions

View File

@ -3,6 +3,15 @@
You get the images as `Magick::Image`. This allows you to make all kinds of
modifications.
![](https://doc.schlomp.space/identiconpp/identicon1.png
"4x4 identicon, ltr_symmetric, 20px padding")
![](https://doc.schlomp.space/identiconpp/identicon2.png
"5x5 identicon, sigil")
![](https://doc.schlomp.space/identiconpp/identicon3.png
"5x5 identicon, ltr_asymmetric")
![](https://doc.schlomp.space/identiconpp/identicon4.png
"6x4 identicon, ltr_symmetric, 10px padding")
## Features
* [x] Symmetric identicons
@ -21,6 +30,10 @@ 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.
The "sigil" algorithm generates the same results as
[sigil](https://github.com/cupcake/sigil/) and
[pydenticon](https://github.com/azaghal/pydenticon/).
### Example
```C++

View File

@ -40,8 +40,15 @@ public:
*/
enum class algorithm
{
//! Generates symmetric (vertically mirrored) identicons.
ltr_symmetric,
//! Generates asymmetric identicons.
ltr_asymmetric,
/*!
* Generates the same results as
* [sigil](https://github.com/cupcake/sigil/) and
* [pydenticon](https://github.com/azaghal/pydenticon/).
*/
sigil
};