mirror of
https://github.com/walkxcode/dashboard-icons.git
synced 2024-11-23 03:43:30 +01:00
c4bfa50a72
* Anchor each icon image to CDN Signed-off-by: bgh-github <99472455+bgh-github@users.noreply.github.com> * Adjust icon download instructions/examples Signed-off-by: bgh-github <99472455+bgh-github@users.noreply.github.com> --------- Signed-off-by: bgh-github <99472455+bgh-github@users.noreply.github.com>
79 lines
2.9 KiB
Markdown
79 lines
2.9 KiB
Markdown
<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 place to find icons for your dashboards.
|
||
<br />
|
||
<a href="#-icons"><strong>👀 See the icons</strong></a> • <a href="https://shop.walkx.fyi/l/donate" target="_blank"><strong>🙌🏻 Donate</strong></a>
|
||
<br />
|
||
<br />
|
||
</p>
|
||
</p>
|
||
|
||
# 📖 Table of Contents
|
||
|
||
- [🚀 Getting Started](#-getting-started)
|
||
- [📊 Dashboards](#-dashboards)
|
||
- [🛠️ Installation](#️-installation)
|
||
- [🎨 Icons](#-icons)
|
||
- [🎉 Contributing Guidelines](#-contributing-guidelines)
|
||
- [📜 Legal](#-legal)
|
||
|
||
## 🚀 Getting Started
|
||
|
||
### 📊 Dashboards
|
||
|
||
There are many Dashboards available that you can use with Dashboard Icons. Here are some of the popular ones.
|
||
|
||
- [Homarr](https://github.com/ajnart/homarr)\*
|
||
- [Dashy](https://github.com/Lissy93/dashy)\*
|
||
- [Homer Dashboard](https://github.com/bastienwirtz/homer)
|
||
- [Heimdall](https://github.com/linuxserver/Heimdall)
|
||
- [Organizr(v2)](https://github.com/causefx/Organizr)
|
||
- [Flame](https://github.com/pawelmalak/flame)
|
||
- [SUI](https://github.com/jeroenpardon/sui)
|
||
- [Homepage](https://github.com/benphelps/homepage)\*
|
||
|
||
**Note:** Dashboards with a \* have native integration with Dashboard Icons.
|
||
|
||
### 🛠️ Installation
|
||
|
||
**Tip!** You can access Dashboard Icons online, faster, by using `https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/example.png`. Just replace `example` with the name of the icon!
|
||
|
||
To download an icon from the [icons page](#-icons), simply `Right click > Save link as`.
|
||
|
||
For non-desktop operating systems or people who prefer to use the terminal:
|
||
|
||
```sh
|
||
$ curl -O https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/example.png
|
||
```
|
||
|
||
or
|
||
|
||
```sh
|
||
$ wget https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/example.png
|
||
```
|
||
|
||
## 🎨 Icons
|
||
**⚠️ Warning!** Going to this page will load every single icon in the repository. This might cause:
|
||
- 📉 An excessive amount of data use.
|
||
- 💻 System slowdowns.
|
||
- 🌐 Browser crashes.
|
||
|
||
*If your device cannot handle loading more than 1000 images, we advise to not go to this page.*
|
||
|
||
➡️ Click [**here**](ICONS.md) to display all icons.
|
||
|
||
## 🎉 Contributing Guidelines
|
||
Please read the [Contributing Guidelines](CONTRIBUTING.md) before contributing to this project.
|
||
|
||
## 📜 Legal
|
||
|
||
(Almost) All product names, trademarks, and registered trademarks in the images in this repository are the property of their respective owners. All images in this repository are used by the users of the Dashboard Icons project for identification purposes only.
|
||
|
||
The use of these names, trademarks, and brands appearing in these image files does not imply endorsement.
|
||
|