1
0
Fork 0
mirror of https://github.com/walkxcode/dashboard-icons.git synced 2024-12-05 17:35:45 +01:00
dashboard-icons/README.md

74 lines
2.5 KiB
Markdown
Raw Permalink Normal View History

2024-04-03 13:06:12 +02:00
<div align="center">
<h2 align="center"> 🚀 Dashboard Icons </h2>
2022-08-16 18:56:44 +02:00
<p align="center">
<a href="https://www.jsdelivr.com/package/gh/walkxcode/dashboard-icons">
2023-04-14 10:36:10 +02:00
<img src="https://img.shields.io/jsdelivr/gh/hy/walkxcode/dashboard-icons?color=%23A020F0" alt="JSdelivr weekly downloads badge">
2022-08-16 18:56:44 +02:00
</a>
</p>
<p align="center">
2024-04-03 13:06:12 +02:00
The best source for dashboard icons.
2023-04-13 22:43:53 +02:00
<br />
2024-04-03 13:06:12 +02:00
<a href="#-icons"><strong>➡️ Explore the icons</strong></a>
2023-04-13 22:43:53 +02:00
<br />
<br />
</p>
2024-04-03 13:06:12 +02:00
</div>
2022-08-16 18:56:44 +02:00
2023-04-14 10:36:10 +02:00
# 📖 Table of Contents
2022-12-11 15:28:20 +01:00
2024-04-03 13:06:12 +02:00
- [📖 Table of Contents](#-table-of-contents)
- [🚀 Getting Started](#-getting-started)
- [📊 Dashboards](#-dashboards)
- [✨ Usage](#-usage)
- [🎨 Icons](#-icons)
- [🎉 Contribution Guidelines](#-contribution-guidelines)
- [📜 Legal](#-legal)
2023-04-13 22:43:53 +02:00
2023-04-14 10:36:10 +02:00
## 🚀 Getting Started
2022-08-16 18:56:44 +02:00
2023-04-14 10:36:10 +02:00
### 📊 Dashboards
2022-08-16 18:56:44 +02:00
2024-04-03 13:06:12 +02:00
Several dashboards now offer seamless integration with Dashboard Icons. Here are some of the top choices:
2022-08-16 18:56:44 +02:00
2024-04-03 13:06:12 +02:00
- [Homepage](https://github.com/gethomepage/homepage)
- [Homarr](https://github.com/ajnart/homarr)
- [Dashy](https://github.com/Lissy93/dashy)
2022-08-16 18:56:44 +02:00
2024-04-03 13:06:12 +02:00
### ✨ Usage
2022-08-16 19:42:07 +02:00
To download an icon from the [icons page](#-icons), simply `Right click > Save link as`.
2022-08-16 18:56:44 +02:00
2024-04-03 13:06:12 +02:00
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.*
2022-12-11 15:28:20 +01:00
2022-08-16 18:56:44 +02:00
```sh
2024-04-03 13:06:12 +02:00
curl -O https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/example.png
2022-08-16 18:56:44 +02:00
```
2022-12-11 15:28:20 +01:00
2022-08-16 18:56:44 +02:00
or
2022-12-11 15:28:20 +01:00
2022-08-16 18:56:44 +02:00
```sh
2024-04-03 13:06:12 +02:00
wget https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/example.png
2022-08-16 18:56:44 +02:00
```
2024-04-03 13:06:12 +02:00
**💡 Tip!** Access Dashboard Icons online faster via `https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/example.png`, replacing `example` with the icon name!
2023-04-14 10:36:10 +02:00
## 🎨 Icons
2024-04-03 13:06:12 +02:00
**⚠️ Warning!** Visiting this page will load every single icon in the repository. This may cause:
- 📉 Excessive data usage.
- 💻 System slowdowns.
- 🌐 Browser crashes.
2024-04-03 13:06:12 +02:00
*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.*
2024-04-03 13:06:12 +02:00
➡️ Click [**here**](ICONS.md) to view all icons.
2022-08-16 18:56:44 +02:00
2024-04-03 13:06:12 +02:00
## 🎉 Contribution Guidelines
Please review the [Contribution Guidelines](CONTRIBUTING.md) before contributing to this project.
2022-12-11 15:28:20 +01:00
2023-04-14 10:36:10 +02:00
## 📜 Legal
2022-08-16 18:56:44 +02:00
2024-04-03 13:06:12 +02:00
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.
2023-04-14 10:34:33 +02:00
For questions or concerns regarding the license, contact me at hey@lammers.media before using or distributing the contents of this repository.