Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alekorhonen authored Apr 26, 2021
1 parent fb26ff2 commit 167798f
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,12 @@
# icon-captcha
Static icon captcha, that generates a sprite.
# Icon Captcha for PHP
Inspired from [fabianwennink's icon captcha](https://github.com/fabianwennink/IconCaptcha-Plugin-jQuery-PHP). Although fabianwennink's icon captcha works nicely, there was some modifications to be made. The modifications are listed below:
* Starting with not capping the icon amount, automatically calculating how many icons are there in the user's set folder.
* Instead of having just 1 icon that needs to be selected, I modified it to have 2.
* Instead of requesting each icon separately, we generate a sprite so that the front-end only needs to load the icons once.
* Made noise of the icon more controllable, instead of it being capped to a limited amount (which was originally 50).
* Addon is now more static website focused, meaning it's easier to integrate into websites that do not use JavaScript.

# To-Do
* Remove flex styling to support older browsers
* Make the amount of icon's modifiable
* Automatically generatable captcha, instead of c+p the current code in.

0 comments on commit 167798f

Please sign in to comment.