scripts/generate_readme.py

@@ -10,62 +10,22 @@ if __name__ == "__main__":
     img_tags = [generate_img_tag(x) for x in imgs]
 
     with open("README.md", "wt", encoding="UTF-8") as f:
-        f.write("<p align = \"center\" >\n")
-        f.write("  <h3 align = \"center\" > Dashboard Icons </h3>\n")
-        f.write("\n")
-        f.write("  <p align = \"center\" >\n")
-        f.write("    Dashboard Icons for your selfhosted services.\n")
-        f.write(" <br/>\n")
+        f.write("# Dashboard Icons\n\n")
+        f.write("### The best Dashboards:\n\n")
         f.write(
-            "    <a href = \"#icons\" > <strong > Get icons »</strong> </a>\n")
-        f.write("</p>\n")
-        f.write("\n")
-        f.write("# Table of Contents\n")
-        f.write("- [Table of Contents](#table-of-contents)\n")
-        f.write("- [Getting Started](#getting-started)\n")
-        f.write("  - [Dashboards](#dashboards)\n")
-        f.write("  - [Installation](#installation)\n")
-        f.write("- [Icons](#icons)\n")
-        f.write("- [Legal](#legal)\n")
-        f.write("\n")
-        f.write("<!-- GETTING STARTED -->\n")
-        f.write("# Getting Started\n")
-        f.write("\n")
-        f.write("## Dashboards\n")
-        f.write("\n")
-        f.write(
-            "There's multiple Dashboards available. Here are some of the popular ones.\n")
-        f.write("\n")
-        f.write("- [Dashy*](https://github.com/Lissy93/dashy)\n")
-        f.write(
-            "- [Homer Dashboard](https://github.com/bastienwirtz/homer)\n")
+            "- [Dashy (Icons Natively Supported)](https://github.com/Lissy93/dashy)\n")
+        f.write("- [Homer Dashboard](https://github.com/bastienwirtz/homer)\n")
         f.write("- [Heimdall](https://github.com/linuxserver/Heimdall)\n")
-        f.write("- [Organizr(v2)](https://github.com/causefx/Organizr)\n")
+        f.write("- [Organizr (v2)](https://github.com/causefx/Organizr)\n")
         f.write("- [Flame](https://github.com/pawelmalak/flame)\n")
-        f.write("- [SUI](https://github.com/jeroenpardon/sui)\n")
-        f.write("\n")
-        f.write("## Installation\n")
+        f.write("- [SUI](https://github.com/jeroenpardon/sui)\n\n\n")
         f.write(
-            "_*Dashy natively supports all icons in this repo, and is synced automatically. (Clicking [this link](https://github.com/Lissy93/dashy/blob/master/docs/icons.md#home-lab-icons) will take you to the docs that explain how to use the integration.)_\n")
-        f.write("\n")
-        f.write("To download an icon, simple `Right click > Save image`.\n")
-        f.write("\n")
+            "##### [How to download images on UNIX?](#how-to-download-images-on-unix-1)\n\n")
         f.write(
-            "For non-desktop operating systems, or people that prefer to use terminal.\n")
-        f.write("```sh\n")
-        f.write("$ curl https://raw.githubusercontent.com/walkxhub/dashboard-icons/master/png/example.png > example.png\n")
-        f.write("```\n")
-        f.write("or\n")
-        f.write("```sh\n")
-        f.write("$ wget https://raw.githubusercontent.com/walkxhub/dashboard-icons/master/png/example.png - O example.png\n")
-        f.write("```\n")
-        f.write("\n")
-        f.write("<!-- ICONS -->\n")
-        f.write("# Icons\n")
+            "##### [How to use icons in Dashy natively?](https://github.com/Lissy93/dashy/blob/master/docs/icons.md#home-lab-icons)\n\n\n")
         f.write(" ".join(img_tags))
-        f.write("\n\n")
-        f.write("<!-- LEGAL -->\n")
-        f.write("# Legal\n")
-        f.write("(Almost) All product names, trademarks and registered trademarks in the images in this repository, are property of their respective         owners. All images in this repository are used by the users of the Dashboard Icons project for identification purposes only.\n")
-        f.write("\n")
-        f.write("The use of these names, trademarks and brands appearing in these image files, do not imply endorsement.\n")
+        f.write("\n\n\n")
+        f.write("---\n\n### How to download images on UNIX?\n\n\n`UNIX`\n\n```bash\n\n$ curl https://raw.githubusercontent.com/WalkxCode/dashboard-icons/master/png/example.png > example.png\n\n```\nor\n```bash\n\n$ wget https://raw.githubusercontent.com/WalkxCode/dashboard-icons/master/png/example.png -O example.png\n\n```")
+        f.write("\n\n\n---\n\n## Trademark Legal Notices\n\n(Almost) All product names, trademarks and registered trademarks in the images in this repository, are property of their respective owners. All images in this repository are used by the users of the Dashboard Icons project for identification purposes only.\n\n\nThe use of these names, trademarks and brands appearing in these image files, do not imply endorsement.")
+        f.write(
+            "\n\n\n---\n\n## Mentions\nThis project has been mentioned on:\n\n#### The Official Dashy Docs\n[Home-Lab Icons](https://github.com/Lissy93/dashy/blob/master/docs/icons.md#home-lab-icons)\n\n#### Awesome Open Source\n[YouTube](https://youtu.be/QsQUzutGarA?t=580)\n[Show notes](https://shownotes.opensourceisawesome.com/dashy-powerful-informative/)\n\n#### r/selfhosted\n[u/BackedUpBooty](https://www.reddit.com/r/selfhosted/comments/qu11pf/comment/hkp7v3o/?utm_source=share&utm_medium=web2x&context=3)\n[u/marusb](https://www.reddit.com/r/selfhosted/comments/q4tnac/comment/hg2sovy/?utm_source=share&utm_medium=web2x&context=3)\n[u/Jonathan_Fu](https://www.reddit.com/r/selfhosted/comments/podb3c/comment/hcxf4eb/?utm_source=share&utm_medium=web2x&context=3)")

svg/gatus.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 89.76 89.75"><defs><style>.cls-1{fill:#3cad4b;}.cls-2{fill:#017400;}.cls-3{fill:#1e9025;}</style></defs><g id="Layer_2" data-name="Layer 2"><g id="Layer_1-2" data-name="Layer 1"><path class="cls-1" d="M33.67,65.35a23.35,23.35,0,0,1,.08-41,22.94,22.94,0,0,1,3.8-1.64A23,23,0,0,0,53.6,1C53,0,51,0,44.89,0c-9.08,0-9.21.17-8.81,3.22,1.07,8.12-9.42,12.5-14.45,6-1.94-2.52-2.1-2.52-8.68,4.16-6.22,6.3-6.33,6.28-3.77,8.25a8.09,8.09,0,0,1,2.56,9.53A8.15,8.15,0,0,1,3.08,36C0,35.63,0,35.73,0,45.2.08,53.81,0,54,3.3,53.63A8.06,8.06,0,0,1,9.76,67.52c-3,2.83-2.84,2.61,2.84,8.48,5.43,5.62,6.33,6.73,8.16,5.24L34,68A1.63,1.63,0,0,0,33.67,65.35Z"/><path class="cls-2" d="M85.43,36.13a8.11,8.11,0,0,1-5.27-14.21c2.85-2.5,2.82-2.37-3.55-8.75-4.31-4.31-5.71-5.75-6.87-5.4l-14,14a1.65,1.65,0,0,0,.36,2.61,23.35,23.35,0,0,1-.1,41,24.5,24.5,0,0,1-5.11,2c-8.54,2.28-14.73,9.63-14.73,18.47v1.27c.15,2.54,1.19,2.42,8.06,2.52,9.32.14,9.1.35,9.38-4.66a8.11,8.11,0,0,1,14-5.09c3,3.15,2.39,3.11,8.73-3.14,6.56-6.47,6.86-6.25,3.68-9.14a8.1,8.1,0,0,1,6.06-14.07c3.68.27,3.51.06,3.63-8.09C89.85,36.27,90,36.16,85.43,36.13Z"/><path class="cls-3" d="M41.11,59h8a.76.76,0,0,0,.77-.76V50.43a.76.76,0,0,1,.77-.76h7.84a.78.78,0,0,0,.77-.77V40.84a.77.77,0,0,0-.77-.76H50.7a.76.76,0,0,1-.77-.77V31.47a.76.76,0,0,0-.77-.77h-8a.76.76,0,0,0-.77.77v7.84a.76.76,0,0,1-.77.77H31.73a.77.77,0,0,0-.77.76V48.9a.78.78,0,0,0,.77.77h7.84a.76.76,0,0,1,.77.76v7.85A.76.76,0,0,0,41.11,59Z"/></g></g></svg>

svg/portainer.svg

@@ -1 +0,0 @@
-<svg height="2500" viewBox=".16 0 571.71 800" width="1788" xmlns="http://www.w3.org/2000/svg"><g fill="#13bef9"><path d="m190.83 175.88h-12.2v63.2h12.2zm52.47 0h-12.2v63.2h12.2zm71.69-120.61-12.5-21.68-208.67 120.61 12.5 21.68z"/><path d="m313.77 55.27 12.51-21.68 208.67 120.61-12.51 21.68z"/><path d="m571.87 176.18v-25.03h-571.71v25.03z"/><path d="m345.5 529.77v-370.99h25.02v389.01c-6.71-7.64-15.26-13.13-25.02-18.02zm-42.71-6.41v-523.36h25.02v526.41c-7.02-3.36-24.1-3.05-25.02-3.05zm-237.04 52.21c-30.51-22.59-50.64-58.62-50.64-99.54 0-21.68 5.79-43.05 16.47-61.68h213.55c10.98 18.63 16.48 40 16.48 61.68 0 18.93-2.44 36.64-10.07 52.52-16.17-15.57-39.97-22.29-64.07-22.29-42.71 0-79.32 26.56-88.77 66.26-3.36-.31-5.49-.61-8.85-.61-8.24.3-16.17 1.53-24.1 3.66z" fill-rule="evenodd"/><path d="m170.69 267.18h-64.67v65.03h64.67zm-72.91 0h-64.67v65.03h64.67zm0 72.36h-64.67v65.04h64.67zm72.91 0h-64.67v65.04h64.67zm72.61 0h-64.67v65.04h64.67zm0-107.17h-64.67v65.03h64.67z"/><path d="m109.37 585.34c8.85-37.55 42.71-65.65 82.98-65.65 25.94 0 49.12 11.61 64.99 29.93 13.72-9.47 30.2-14.96 48.2-14.96 46.98 0 85.11 38.16 85.11 85.19 0 9.77-1.52 18.93-4.57 27.78 10.37 14.05 16.78 31.76 16.78 50.69 0 47.02-38.14 85.19-85.12 85.19-20.75 0-39.66-7.33-54.3-19.54-15.56 21.68-40.88 36.03-69.56 36.03-32.95 0-61.63-18.93-75.96-46.41-5.8 1.22-11.6 1.83-17.7 1.83-46.98 0-85.42-38.17-85.42-85.19s38.14-85.19 85.42-85.19c3.05-.31 6.1-.31 9.15.3z" fill-rule="evenodd"/></g><div xmlns="" id="divScriptsUsed" style="display: none"/><script xmlns="" id="globalVarsDetection" src="moz-extension://bb32ab74-e5c2-4a8f-8a57-a0c16324a00e/js/wrs_env.js"/></svg>