🚀 Much needed maintenance

.github/ISSUE_TEMPLATE/request_suggest.yml

@@ -1,32 +1,34 @@
-name: "\U0001FA79 Requests & Suggestions"
+name: "🔍 Requests & Suggestions"
 description: Suggest an icon or request changes
-labels: "\U0001FA79 Requests & Suggestions"
+labels: "🔍 Requests & Suggestions"
 assignees: walkxcode
 body:
   - type: markdown
     attributes:
-      value: "Thank you for your interest in contributing to our icon repository! To ensure smooth collaboration, we've established clear guidelines for contributors.\n## 🌟 Icon Specifications\n\n- Icons should be provided in both `PNG` and `SVG` formats. Formats like `JPEG` or `WEBP` will not be accepted.\n  - If an `SVG` version is unavailable, a `PNG` version alone suffices.\n  - Conversely, if a `PNG` version is missing, it can be generated using [Ezgif SVG to PNG](https://github.com/walkxcode/dashboard-icons/blob/main/CONTRIBUTING.md#-converting-svg-to-png).\n\n- `PNG` files should have a height of exactly `512px` Width can vary, but a 1:1 aspect ratio is preferred.\n  - ❗ Exceptions for upscales will be made only if the correct or a downscaled version cannot be obtained.\n  - Downsizing can be accomplished using [iLoveIMG Resize](https://github.com/walkxcode/dashboard-icons/blob/main/CONTRIBUTING.md#-downscaling-pngs).\n\n- Icons should be named using the [Kebab Case](https://wiki.c2.com/?KebabCase) convention, reflecting their full name. For instance, \"Facebook Messenger\" should be named `facebook-messenger.png`.\n\n- Monochrome icons should default to a dark version. Light versions should be named `name-light.png`. If a light version is absent, utilize [https://pinetools.com/colorize-image](https://pinetools.com/colorize-image) to adjust its color.\n"
+      value: |
+        Thank you for your interest in contributing to our icon repository! To ensure smooth collaboration, please make sure to read and agree to our [Contribution Guidelines](https://github.com/walkxcode/dashboard-icons/blob/main/CONTRIBUTING.md) before submitting your request.
+
   - type: checkboxes
     attributes:
       label: Contribution Guidelines
       options:
-        - label: I have read and agree to the [Contribution Guidelines](https://github.com/walkxcode/dashboard-icons/blob/main/CONTRIBUTING.md)
+        - label: "I have read and agree to the [Contribution Guidelines](https://github.com/walkxcode/dashboard-icons/blob/main/CONTRIBUTING.md)"
           required: true
+
   - type: textarea
     id: icon-name
     attributes:
       label: Icon Name
-      description: What is the name of the icon you are contributing?
+      description: What is the name of the icon you are requesting or suggesting?
       placeholder: Enter icon name here
     validations:
       required: true
+
   - type: textarea
-    id: icons
+    id: icon-details
     attributes:
-      label: Icon(s)
-      description: >-
-        Upload your icons here. You can do this by Copy-Pasting or Drag &
-        Dropping the images.
-      placeholder: Copy-Paste or Drag & Drop images here!
+      label: Icon Details
+      description: Provide any additional details or context for the icon request.
+      placeholder: Enter details here
     validations:
       required: false

.github/workflows/compress_pngs.yml

@@ -0,0 +1,33 @@
+name: Compress PNGs 🗜️
+
+on:
+  schedule:
+    - cron: "0 0 * * 0"
+  workflow_dispatch:
+
+jobs:
+  compress_pngs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+
+      - name: Install Dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y zopfli
+
+      - name: Compress PNG Files
+        run: |
+          echo "Compressing PNGs..."
+          find png/ -iname "*.png" -print0 | xargs -0 -P 4 -I{} zopflipng -y {} {}
+
+      - name: Commit and Push Changes
+        run: |
+          git config --global user.email "noreply@lammers.media"
+          git config --global user.name "Dashboard Icons Bot"
+          git add png/
+          git commit -m ":compression: Compressed PNGs" || exit 0
+          git pull --rebase
+          git push

.github/workflows/generate_file_tree.yml

@@ -0,0 +1,31 @@
+name: Generate File Tree 🌳
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  generate_file_tree:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+
+      - name: Set Up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+
+      - name: Generate File Tree
+        run: python scripts/generate_file_tree.py svg png webp
+
+      - name: Commit and Push Changes
+        run: |
+          git config --global user.email "noreply@lammers.media"
+          git config --global user.name "Dashboard Icons Bot"
+          git add tree.json
+          git commit -m ":construction_worker: Generate file tree" || exit 0
+          git push

.github/workflows/generate_icons_page.yml

@@ -0,0 +1,31 @@
+name: Generate Icons Page 🚀
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  build_icons_page:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+
+      - name: Set Up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+
+      - name: Generate ICONS.md
+        run: python scripts/generate_icons_page.py
+
+      - name: Commit and Push Changes
+        run: |
+          git config --global user.email "noreply@lammers.media"
+          git config --global user.name "Dashboard Icons Bot"
+          git add ICONS.md
+          git commit -m ":construction_worker: Generate ICONS.md" || exit 0
+          git push

.github/workflows/icons-page-generation.yml

@@ -1,32 +0,0 @@
-name: 🚀 Generates ICONS
-
-on:
-  push:
-  workflow_dispatch:
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Setup Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: "3.9"
-          architecture: "x64"
-
-      - name: ICONS Generator
-        run: |-
-          python config/ci.py
-          cat ICONS.md
-
-      - name: Load to GitHub
-        run: |-
-          git diff
-          git config --global user.email "noreply@lammers.media"
-          git config --global user.name "Dashboard Icons Bot"
-          git add -A
-          git commit -m ":construction_worker: Generates ICONS.md" || exit 0
-          git push

.github/workflows/png-compression.yml

@@ -1,32 +0,0 @@
-name: 🗜️ PNG Compression
-
-on:
-  schedule:
-    - cron: "0 0 * * 0"
-  workflow_dispatch:
-
-jobs:
-  compress-images:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v2
-      - name: Install Dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y zopfli
-
-      - name: Compress PNGs
-        run: |
-          echo "Compressing PNGs..."
-          find png/ -iname "*.png" -print0 | xargs -0 -P 4 -I{} sh -c 'echo "Compressing {}"; zopflipng -y {} {}' || true
-
-      - name: Load to GitHub
-        run: |-
-          git diff
-          git config --global user.email "noreply@walkx.fyi"
-          git config --global user.name "Dashboard Icons Bot"
-          git add -A
-          git commit -m ":children_crossing: Compresses PNGs" || exit 0
-          git pull --ff-only
-          git push

.github/workflows/validate_and_preview_icons.yml

@@ -0,0 +1,72 @@
+name: Validate and Preview Icons 🛠️
+
+on:
+  pull_request:
+    types: [opened, synchronize]
+
+jobs:
+  validate_icons:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+
+      - name: Set Up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.9"
+
+      - name: Install Dependencies
+        run: |
+          pip install cairosvg pillow
+
+      - name: Run SVG to PNG and WEBP Conversion
+        run: python scripts/convert_svg_assets.py
+
+      - name: Upload Converted Icons
+        uses: actions/upload-artifact@v3
+        with:
+          name: converted-icons
+          path: |
+            png/*.png
+            webp/*.webp
+
+      - name: Post Comment with Preview
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          message: |
+            ## Icon Conversion Results
+
+            **Total Icons Processed:** ${{ steps.process.outputs.total_icons }}
+            **Converted PNGs:** ${{ steps.process.outputs.converted_pngs }}
+            **Converted WEBPs:** ${{ steps.process.outputs.converted_webps }}
+            **Removed PNGs:** ${{ steps.process.outputs.removed_pngs }}
+            **Removed WEBPs:** ${{ steps.process.outputs.removed_webps }}
+
+            ${{ steps.process.outputs.failed_files }}
+
+            ### Preview of Converted Icons:
+
+            ${{ steps.preview.outputs.icon_previews }}
+      - name: Set Output Variables
+        id: process
+        run: |
+          echo "::set-output name=total_icons::$(grep 'Total icons:' output.log | awk '{print $3}')"
+          echo "::set-output name=converted_pngs::$(grep 'Converted' output.log | awk '{print $2}')"
+          echo "::set-output name=converted_webps::$(grep 'Converted' output.log | awk '{print $5}')"
+          echo "::set-output name=removed_pngs::$(grep 'Removed' output.log | awk '{print $2}')"
+          echo "::set-output name=removed_webps::$(grep 'Removed' output.log | awk '{print $5}')"
+          echo "::set-output name=failed_files::$(grep 'The following files failed' -A 10 output.log)"
+
+      - name: Generate Icon Previews
+        id: preview
+        run: |
+          ICONS=$(find png/ -type f -name "*.png")
+          PREVIEWS=""
+          for ICON in $ICONS; do
+            ICON_NAME=$(basename $ICON)
+            PREVIEW="![${ICON_NAME}](https://raw.githubusercontent.com/walkxcode/dashboard-icons/${{ github.event.pull_request.head.ref }}/png/${ICON_NAME})"
+            PREVIEWS="$PREVIEWS $PREVIEW"
+          done
+          echo "::set-output name=icon_previews::$PREVIEWS"

CODE_OF_CONDUCT.md

@@ -1,23 +1,30 @@
-# 🚨 Code of Conduct
+## Code of Conduct
 
-We are committed to providing a welcoming and harassment-free environment for everyone who wants to participate in our icon repository, regardless of gender, gender identity and expression, sexual orientation, disability, physical appearance, body size, race, age, religion, or nationality.
+We are committed to creating a welcoming and harassment-free environment for everyone who contributes to our icon repository. This includes people of all genders, gender identities, sexual orientations, disabilities, appearances, body sizes, races, ages, religions, and nationalities.
 
-## 💬 Communication
+### Communication
 
-All communication should be appropriate for a professional audience including people of many different backgrounds. Be respectful, considerate, and constructive in all communication, both online and offline.
+All communication should be appropriate for a professional audience, respectful, constructive, and considerate of people from different backgrounds. Please aim to create a positive and inclusive atmosphere.
 
-## 🚫 Prohibited Behavior
+### Prohibited Behavior
 
-Harassment, intimidation, discrimination, or any other inappropriate conduct or behavior will not be tolerated. This includes, but is not limited to, the use of sexual language or imagery, deliberate intimidation, stalking, following, harassing photography or recording, sustained disruption of talks or other events, inappropriate physical contact, and unwelcome sexual attention.
+We do not tolerate harassment, intimidation, discrimination, or any other inappropriate conduct, whether in communication or behavior. Prohibited actions include:
 
-## 📢 Reporting
+- The use of sexual language or imagery
+- Deliberate intimidation or stalking
+- Unwelcome sexual attention or harassment
+- Inappropriate physical contact
+- Disruptions during events or conversations
+- Discrimination of any kind
 
-If you believe someone is violating the code of conduct, please report it immediately to walkxnl@gmail.com. All reports will be reviewed and investigated promptly and confidentially.
+### Reporting
 
-## 🚨 Consequences
+If you witness or experience behavior that violates this code of conduct, please report it immediately to [bjorn@lammers.media](mailto:bjorn@lammers.media). All reports will be reviewed confidentially and promptly, and appropriate actions will be taken.
 
-Anyone found to be engaging in behavior that violates the code of conduct will be subject to appropriate action, which may include, but is not limited to, warning, removal from the repository, or banning from participation in the repository.
+### Consequences
 
-## 👍 Acknowledgment
+Anyone violating this code of conduct may face consequences, such as warnings, removal from the repository, or a ban from future participation. We take violations seriously to ensure a safe and welcoming environment for everyone.
 
-We ask that all participants in this repository agree to abide by this code of conduct. By contributing to this repository, you agree to these terms and conditions. Thank you for helping us create a welcoming and inclusive environment for all. 🙏
+### Acknowledgment
+
+By contributing to this repository, you agree to adhere to this code of conduct. Thank you for helping us create an inclusive and supportive environment for all contributors.

CONTRIBUTING.md

@@ -1,50 +1,78 @@
-# 🤝 Contribution Guidelines
+![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen?style=flat-square)
 
-We appreciate your interest in contributing to our icon repository! To ensure smooth collaboration, kindly adhere to the following guidelines:
+## Contribution Guidelines
 
-## 🌟 Icon Specifications
+Thank you for your interest in contributing to the icon repository! To ensure smooth collaboration, please follow these guidelines. Your contributions help make this project better.
 
-- Icons should be provided in both `PNG` and `SVG` formats. Other formats like `JPEG` or `WEBP` will not be accepted.
-  - In cases where an `SVG` version is unavailable, a `PNG` version alone suffices.
-  - Conversely, if a `PNG` version is missing, it can be generated using [Ezgif SVG to PNG](#-converting-svg-to-png).
-- `PNG`s should maintain a height of exactly `512px`, while width can vary. However, a 1:1 aspect ratio is preferred.
-  - ❗ Avoid upscales! Exceptions will be made only if the correct or a downscaled version cannot be obtained.
-  - Downsizing can be accomplished using [iLoveIMG Resize](#-downscaling-pngs).
-- Icons should be named using the [Kebab Case](https://wiki.c2.com/?KebabCase) convention, reflecting their full name. For instance, "Facebook Messenger" should be named `facebook-messenger.png`.
-- Icons that are predominantly monochrome should default to a dark version. Light versions should be named `name-light.png`. If a light version is not available, use [https://pinetools.com/colorize-image](https://pinetools.com/colorize-image) to adjust its color.
+## Table of Contents
 
-## 💻 Gitmoji Commits
+- [Contribution Guidelines](#contribution-guidelines)
+- [Table of Contents](#table-of-contents)
+- [Icon Specifications](#icon-specifications)
+  - [Format](#format)
+  - [Cropping](#cropping)
+  - [Light and Dark Versions](#light-and-dark-versions)
+  - [File Naming](#file-naming)
+  - [Quality Requirements](#quality-requirements)
+- [Git Commit Messages](#git-commit-messages)
+- [Contribution Process](#contribution-process)
+- [Code of Conduct](#code-of-conduct)
+- [Contact](#contact)
 
-- Use [Gitmoji](https://gitmoji.dev/) in your commit messages. This helps us keep our commit history clear and easy to understand. For instance, use the `🍱` emoji for commits related to updating icon colors, and `📝` for documentation updates.
+## Icon Specifications
 
-## 🔀 Converting SVG to PNG
+### Format
 
-1. Go to https://ezgif.com/svg-to-png.
-2. Upload the `SVG` file by clicking "Upload".
-3. Set the "Height (optional)" field to `512`, leaving other settings as default.
-4. Click "Convert to PNG!".
-5. Click "Save" located at the bottom right under the converted image.
+- **SVG Format Required**: All icons must be submitted in SVG format.
+- **Automatic PNG and WEBP Generation**: PNG and WEBP versions are generated automatically from the SVG files using the following settings:
+  - **Dimensions**:
+    - Height: 512 pixels
+    - Width: Auto (maintaining aspect ratio)
+  - **Transparency**: Enabled
 
-## ⤵️ Downscaling PNGs
+### Cropping
 
-1. Go to https://www.iloveimg.com/resize-image.
-2. Upload the `PNG` file(s).
-3. Adjust the "Height (px)" field to `512`, leaving other settings as default.
-4. Click "Resize IMAGES".
-5. Download the resized icon(s).
+- **Remove Empty Space**: Crop any empty space from your SVG files to ensure the icon is properly centered and sized. You can use [SVG Crop](https://svgcrop.com/) to assist with this.
 
-## 🤝 Contributing
+### Light and Dark Versions
 
-1. Fork the repository to your GitHub account.
-2. Clone the repository to your local machine.
-3. Add your icon(s) to the repository, adhering to the specified guidelines.
-4. Push your changes to your fork.
-5. Create a pull request in the main repository.
+- **Monochrome or Single Primary Color Icons**:
+  - If your icon is monochrome, please provide additional versions if applicable:
+    - **`-light` Version**: For icons primarily dark or using black as a main color, provide a `-light` version for light backgrounds.
+    - **`-dark` Version**: For icons primarily light or using white as a main color, provide a `-dark` version for dark backgrounds.
+  - **Examples**:
+    - A black logo should include a `-light` version where black is inverted.
+    - A multicolored logo using black should provide a `-light` version with the black replaced.
+  - **Tool Recommendation**: [DEEditor](https://deeditor.com/) can help adjust icon colors if needed.
 
-## 🚨 Code of Conduct
+### File Naming
 
-Kindly note that contributing to this repository necessitates adherence to our code of conduct, outlined in the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file within the repository.
+- **Kebab Case**: Name your files using kebab case (lowercase words separated by hyphens). For example, "Nextcloud Calendar" becomes `nextcloud-calendar.svg`.
+  - **Note**: Filenames are automatically converted to kebab case, but please double-check your naming to avoid conflicts or errors.
 
----
+### Quality Requirements
 
-Should you have any queries or concerns, feel free to reach out to me using walkxnl@gmail.com. Happy contributing! 🙌
+- **No Upscaled Images**: Icons should maintain their original quality without artificial enlargement.
+- **No Embedded Raster Images in SVGs**: Ensure that SVG files are true vector graphics without embedded raster images.
+
+## Git Commit Messages
+
+- **Use Gitmoji**: Incorporate [Gitmoji](https://gitmoji.dev/) in your commit messages to keep the commit history clear and expressive. For example:
+  - `:bento: Adds xxx` when adding new icons.
+
+## Contribution Process
+
+1. **Fork the Repository**: Create a fork of this repository on your GitHub account.
+2. **Clone the Repository**: Clone your forked repository to your local machine.
+3. **Add Your Icons**: Place your SVG icon(s) into the appropriate directory, following the specifications above.
+4. **Commit Your Changes**: Commit your additions with clear and descriptive commit messages using Gitmoji.
+5. **Push to Your Fork**: Push your committed changes to your forked repository on GitHub.
+6. **Create a Pull Request**: Submit a pull request to the main repository for review.
+
+## Code of Conduct
+
+By contributing, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). Please review it to understand the expectations for all participants.
+
+## Contact
+
+If you have any questions or need assistance, feel free to reach out at [bjorn@lammers.media](mailto:bjorn@lammers.media). I'm happy to help.

LICENSE

@@ -1,16 +1,121 @@
-**Icons and Assets**
+Creative Commons Legal Code
 
-Unless otherwise indicated, all images and assets in this repository, including product names, trademarks, and registered trademarks, are the property of their respective owners. These images and assets are used for identification purposes only and their use does not imply endorsement.
+CC0 1.0 Universal
 
----
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
 
-**Code and Documentation**
+Statement of Purpose
 
-Copyright (c) 2024 Bjorn Lammers (walkxcode)
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

README.md

@@ -1,73 +1,110 @@
-<div align="center">
-  <h2 align="center"> 🚀 Dashboard Icons </h2>
-  <p align="center">
-    <a href="https://www.jsdelivr.com/package/gh/walkxcode/dashboard-icons">
-      <img src="https://img.shields.io/jsdelivr/gh/hy/walkxcode/dashboard-icons?color=%23A020F0" alt="JSdelivr weekly downloads badge">
-    </a>
-  </p>
-  <p align="center">
-    The best source for dashboard icons.
-    <br />
-    <a href="#-icons"><strong>➡️ Explore the icons</strong></a>
-    <br />
-    <br />
-  </p>
-</div>
+![jsDelivr hits (GitHub)](https://img.shields.io/jsdelivr/gh/hy/walkxcode/dashboard-icons?style=flat-square&color=%23A020F0)
 
-# 📖 Table of Contents
+## Dashboard Icons
 
-- [📖 Table of Contents](#-table-of-contents)
-  - [🚀 Getting Started](#-getting-started)
-    - [📊 Dashboards](#-dashboards)
-    - [✨ Usage](#-usage)
-  - [🎨 Icons](#-icons)
-  - [🎉 Contribution Guidelines](#-contribution-guidelines)
-  - [📜 Legal](#-legal)
+The best source for dashboard icons.<br />
+[**View icons →**](#icons)
 
-## 🚀 Getting Started
+## Table of Contents
+- [Dashboard Icons](#dashboard-icons)
+- [Table of Contents](#table-of-contents)
+- [Icon Requests](#icon-requests)
+- [Supported Dashboards](#supported-dashboards)
+- [Usage and Details](#usage-and-details)
+  - [Direct Links](#direct-links)
+    - [Base URL](#base-url)
+    - [Name](#name)
+    - [Formats](#formats)
+  - [Dark/Light Versions](#darklight-versions)
+  - [Downloading Icons](#downloading-icons)
+- [Disclaimer](#disclaimer)
 
-### 📊 Dashboards
+## Icon Requests
 
-Several dashboards now offer seamless integration with Dashboard Icons. Here are some of the top choices:
+If you're looking to add a new icon, please read the [Contribution Guidelines](CONTRIBUTING.md). Afterwards, submit a Pull Request or open an issue.
+
+## Supported Dashboards
+
+Several dashboards offer seamless integration with Dashboard Icons. Here are some of the most popular options:
 
 - [Homepage](https://github.com/gethomepage/homepage)
 - [Homarr](https://github.com/ajnart/homarr)
 - [Dashy](https://github.com/Lissy93/dashy)
 
-### ✨ Usage
+## Usage and Details
 
-To download an icon from the [icons page](#-icons), simply `Right click > Save link as`.
+### Direct Links
 
-For non-desktop operating systems or those who prefer using the terminal:
-*Replace `example` with the icon's name, and `png` with `svg` if needed.*
+Icons can be used directly from either GitHub or jsDelivr (recommended). Links consist of three components, each described below:
 
-```sh
-curl -O https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/example.png
-```
+- **Base URL**
+- **Name**
+- **Format**
+
+A complete link will look like this:
+
+    https://<Base URL>/<Format>/<Name>.<Format>
+
+For example, the icon URL for the WEBP version of Nextcloud Calendar would be:
+
+    https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/webp/nextcloud-calendar.webp
+
+#### Base URL
+
+We recommend using jsDelivr, a free and fast CDN:
+
+- `https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons`
+
+Alternatively, you can use direct links to the repository:
+
+- `https://raw.githubusercontent.com/walkxcode/dashboard-icons/refs/heads/main`
+
+#### Name
+
+Icons are named using kebab case (lowercase words separated by hyphens). For example, "Nextcloud Calendar" becomes `nextcloud-calendar`.
+
+#### Formats
+
+Icons are available in the following formats:
+
+- SVG
+- PNG
+- WEBP
+
+All icons are generated from the SVG file as the base.
+
+*Read more about the specifics and standards of icons in the [Contribution Guidelines](CONTRIBUTING.md).*
+
+### Dark/Light Versions
+
+In some cases, an icon might have very light or dark colors, making it hard to see on certain backgrounds. In this situation, a `-light` or `-dark` version will be added to the end of the icon's name, with colors adjusted accordingly.
+
+For example, "2fauth" becomes `2fauth-light`.
+
+*Read more about the specifics and standards of icons in the [Contribution Guidelines](CONTRIBUTING.md).*
+
+### Downloading Icons
+
+To download icons from the [icons page](ICONS.md), simply Right-click the icon link and select "Save link as".
+
+**Warning**: Visiting the icons page will load every icon in the repository. This may result in:
+
+- High data usage.
+- System slowdowns.
+- Browser crashes on some devices.
+
+If you prefer not to load all icons at once, consider using the direct links or downloading icons individually.
+
+To download icons using the terminal, use `curl` or `wget`. Refer to [Direct Links](#direct-links) for details on the link structure.
+
+    curl -O https://<Base URL>/<Format>/<Name>.<Format>
 
 or
 
-```sh
-wget https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/example.png
-```
+    wget https://<Base URL>/<Format>/<Name>.<Format>
 
-**💡 Tip!** Access Dashboard Icons online faster via `https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/example.png`, replacing `example` with the icon name!
+## Disclaimer
 
-## 🎨 Icons
-**⚠️ Warning!**  Visiting this page will load every single icon in the repository. This may cause:
-- 📉 Excessive data usage.
-- 💻 System slowdowns.
-	- 🌐 Browser crashes.
+Unless otherwise indicated, all images and assets in this repository, including product names, trademarks, and registered trademarks, are the property of their respective owners. These images and assets are used for identification purposes only, and their use does not imply endorsement.
 
-*If your device cannot handle loading more than 1000 images or if you are on a limited data connection, we advise against visiting this page.*
-
-➡️ Click [**here**](ICONS.md) to view all icons.
-
-## 🎉 Contribution Guidelines
-Please review the [Contribution Guidelines](CONTRIBUTING.md) before contributing to this project.
-
-## 📜 Legal
-
-Read our [LICENSE](LICENSE) for information regarding the use of our software and assets. By accessing or using this repository, you agree to be bound by the terms and conditions of the license.
-
-For questions or concerns regarding the license, contact me at hey@lammers.media before using or distributing the contents of this repository.
+Read the [LICENSE](LICENSE) for more information about the project itself. For questions or concerns, contact me at [bjorn@lammers.media](mailto:bjorn@lammers.media).

config/TEMPLATE.md

@@ -1,20 +0,0 @@
-<p align="center">
-  <h2 align="center"> 🚀 Dashboard Icons </h3>
-  <p align="center">
-    <a href="https://www.jsdelivr.com/package/gh/walkxcode/dashboard-icons">
-      <img src="https://img.shields.io/jsdelivr/gh/hy/walkxcode/dashboard-icons?color=%23A020F0" alt="JSdelivr weekly downloads badge">
-    </a>
-  </p>
-  <p align="center">
-    The best source for dashboard icons.
-    <br />
-    <a href="https://github.com/walkxcode/dashboard-icons/"><strong>⬅️ Back to repo</strong></a>
-    <br />
-    <br />
-  </p>
-</p>
-<div align="center">
-<!-- ICONS -->
-  
-<!-- END ICONS -->
-</div>

config/ci.py

@@ -1,32 +0,0 @@
-import pathlib
-from pathlib import Path
-
-root = pathlib.Path(__file__).parent.resolve()
-template_path = root / "TEMPLATE.md"
-path = root / "../ICONS.md"
-
-
-def generate_img_tag(file):
-    return f'<a href="https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/{file.name}"><img src="https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/{file.name}" alt="{file.stem}" height="50"></a>'
-
-
-imgs = sorted(Path("./png").glob("*.png"))
-img_tags = [generate_img_tag(x) for x in imgs]
-line_number = 0
-
-# Read the template file
-with open(template_path, "r", encoding="UTF-8") as f:
-    lines = f.readlines()
-# Find the line that starts with "<!-- ICONS -->"
-for line in lines:
-    if line.startswith("<!-- ICONS -->"):
-        line_number = lines.index(line)
-        break
-# Insert the icons after the line
-lines.insert(line_number + 1, " ".join(img_tags))
-# Write the new file
-with open(path, "w", encoding="UTF-8") as f:
-    f.write("".join(lines))
-    f.write("\n")
-print("Done!")
-print("Please commit the new ICONS.md file.")