From 28bec4913bc2e5dde9e990fdae197d0823ddc2c1 Mon Sep 17 00:00:00 2001 From: ground7 Date: Sun, 7 Jun 2020 19:09:26 -0700 Subject: [PATCH] Update README.md Update README.md Update README.md Update README.md --- README.md | 86 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 53 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 0fafd84..15d38e3 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,65 @@ # Animated Docker Folder Icons for Unraid +[![License](https://img.shields.io/github/license/ground7/unraid-animated-svgs)](./LICENSE.md) +![Downloads](https://img.shields.io/github/downloads/ground7/unraid-animated-svgs/total.svg) -### Preview -[]() -[]() -[]() -[]() -[]() -[]() -[]() -[]() -[]() -[]() -[]() -[]() -[]() -[]() -[]() -[]() -[]() -[]() -[]() -[]() -[]() -[]() -[]() -[]() -[]() -[]() -[]() -[]() +**Please Note** that only the always-animate variant works with the docker folder plugin as of the most recent release. I'll be leaving animate-on-hover up in case anyone wants to use them in another application where hovering works as intended. -### 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 +## Collection +[]() +[]() +[]() +[]() +[]() +[]() +[]() +[]() +[]() +[]() +[]() +[]() +[]() +[]() +[]() +[]() +[]() +[]() +[]() +[]() +[]() +[]() +[]() +[]() +[]() +[]() +[]() +[]() +[]() +[]() -Issue Template: +## How to Tweak +To change a color look for +```xml +fill="####" +``` +and switch the number to the desired 6-digit RGB hex code. + +For more complicated tweaks that don't affect the animation, I suggest using [inkscape](https://github.com/inkscape/inkscape). Be careful to not change the groupings or the animation will break. Inkscape will add a lot of useless metadata to the svg after saving. If you'd like to clean it up, I suggest using [svgocd](https://github.com/Shtian/vscode-svgocd) with [this yaml](https://github.com/ground7/unraid-animated-svgs/blob/master/.svgo.yml). + +## 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: Animation Suggestion: File: ``` +### Additional Notes 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. [Hernadito](https://github.com/hernandito) is also taking requests on the [Unraid forum](https://forums.unraid.net/topic/92824-icon-collections-for-docker-folder-plugin/). +In addition, I'm only animating svgs with css. 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. [Hernadito](https://github.com/hernandito) is also taking requests on the [Unraid forum](https://forums.unraid.net/topic/92824-icon-collections-for-docker-folder-plugin/). + +## Credits +- Thank you [Hernadito](https://github.com/hernandito) for creating initial svgs for me to work off of. You can check out his color variations of this icon set [here](https://github.com/hernandito/unRAID-Docker-Folder-Animated-Icons---Alternate-Colors). +- Thank you [GuildDarts](https://forums.unraid.net/profile/80260-guilddarts/) for your work on the Unraid Docker Folders plug-in which inspired all this work.