🚀 Much needed maintenance

2024-10-20 19:24:03 +02:00
parent 8d414fa3ef
commit 442e8f9d77
4993 changed files with 53535 additions and 3548 deletions
--- a/README.md
+++ b/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).