Update README.md

Update README.md
Update README.md
This commit is contained in:
ground7
2020-06-01 17:52:53 -07:00
parent 21948f833e
commit f6ca9e31ba

View File

@ -1,2 +1,18 @@
# unraid-animated-svgs
Animated SVGs for the docker folder plugin for unraid
### Animated Docker Folder Icons for Unraid
By default all icons are animated on hover. To make them animate all the time, please remove the pointer event.
### Requests
I am currently taking requests for icons to be animated. If you'd like me to animate an svg icon fill out the following issue template
Issue Template:
```
Folder Category: <what is this a category for?>
Animation Suggestion: <your animation idea>
File: <attach a zip file with the svg>
```
Please check if there's already a satisfactory icon covering the category. If you don't like it, you can still suggest another one.
In addition, I'm only animating svgs. Making them from scratch can be a decent amount of work too, so please make the actual svg yourself. Make sure to layer the svg appropriately if the animation requires it. Svgs can be created pretty easily with the free tool inkscape, and they are often an export option on image editors. Some websites can convert to them as well with varying degrees of success.