dashboard-icons/README.md

80 lines
2.9 KiB
Markdown
Raw Normal View History

2022-08-16 18:56:44 +02:00
<p align="center">
2023-04-14 10:36:10 +02:00
<h2 align="center"> 🟣 Dashboard Icons </h3>
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">
2023-04-14 10:36:10 +02:00
🚀 The best place to find icons for your dashboards.
2023-04-13 22:43:53 +02:00
<br />
2023-04-14 21:02:15 +02:00
<a href="#-icons"><strong>👀 See the icons</strong></a><a href="https://shop.walkx.fyi/l/donate" target="_blank"><strong>🙌🏻 Donate</strong></a>
2023-04-13 22:43:53 +02:00
<br />
<br />
</p>
2023-04-14 10:36:10 +02:00
</p>
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
2023-04-14 10:36:10 +02:00
- [🚀 Getting Started](#-getting-started)
- [📊 Dashboards](#-dashboards)
- [🛠️ Installation](#-installation)
- [🎨 Icons](#-icons)
- [🎉 Contributing Guidelines](#-contributing-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
2023-04-14 10:36:10 +02:00
There are many Dashboards available that you can use with Dashboard Icons. Here are some of the popular ones.
2022-08-16 18:56:44 +02:00
2022-12-11 15:29:26 +01:00
- [Homarr](https://github.com/ajnart/homarr)\*
- [Dashy](https://github.com/Lissy93/dashy)\*
2022-08-16 18:56:44 +02:00
- [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)
2022-12-11 15:29:26 +01:00
- [Homepage](https://github.com/benphelps/homepage)\*
2022-08-16 18:56:44 +02:00
2023-04-14 10:36:10 +02:00
**Note:** Dashboards with a \* have native integration with Dashboard Icons.
### 🛠️ Installation
2022-08-16 18:56:44 +02:00
2023-04-14 10:36:10 +02:00
**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!
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
2023-04-13 22:43:53 +02:00
For non-desktop operating systems or people who prefer to use the terminal:
2022-12-11 15:28:20 +01:00
2022-08-16 18:56:44 +02:00
```sh
$ 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
$ wget https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/example.png
2022-08-16 18:56:44 +02:00
```
2023-04-14 10:36:10 +02:00
## 🎨 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.
2022-08-16 18:56:44 +02:00
2023-04-14 10:36:10 +02:00
## 🎉 Contributing Guidelines
Please read the [Contributing 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
2023-04-13 22:43:53 +02:00
(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.
2022-08-16 18:56:44 +02:00
2023-04-13 22:43:53 +02:00
The use of these names, trademarks, and brands appearing in these image files does not imply endorsement.
2023-04-14 10:34:33 +02:00