mirror of
https://github.com/walkxcode/dashboard-icons.git
synced 2025-10-29 07:47:58 +01:00
📝 Updates documentation
This commit is contained in:
68
README.md
68
README.md
@@ -1,79 +1,73 @@
|
||||
<p align="center">
|
||||
<h2 align="center"> 🟣 Dashboard Icons </h3>
|
||||
<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 place to find icons for your dashboards.
|
||||
The best source for dashboard icons.
|
||||
<br />
|
||||
<a href="#-icons"><strong>👀 See the icons</strong></a> • <a href="https://shop.walkx.fyi/l/donate" target="_blank"><strong>🙌🏻 Donate</strong></a>
|
||||
<a href="#-icons"><strong>➡️ Explore the icons</strong></a>
|
||||
<br />
|
||||
<br />
|
||||
</p>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
# 📖 Table of Contents
|
||||
|
||||
- [🚀 Getting Started](#-getting-started)
|
||||
- [📊 Dashboards](#-dashboards)
|
||||
- [🛠️ Installation](#️-installation)
|
||||
- [🎨 Icons](#-icons)
|
||||
- [🎉 Contributing Guidelines](#-contributing-guidelines)
|
||||
- [📜 Legal](#-legal)
|
||||
- [📖 Table of Contents](#-table-of-contents)
|
||||
- [🚀 Getting Started](#-getting-started)
|
||||
- [📊 Dashboards](#-dashboards)
|
||||
- [✨ Usage](#-usage)
|
||||
- [🎨 Icons](#-icons)
|
||||
- [🎉 Contribution Guidelines](#-contribution-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.
|
||||
Several dashboards now offer seamless integration with Dashboard Icons. Here are some of the top choices:
|
||||
|
||||
- [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/gethomepage/homepage)\*
|
||||
- [Homepage](https://github.com/gethomepage/homepage)
|
||||
- [Homarr](https://github.com/ajnart/homarr)
|
||||
- [Dashy](https://github.com/Lissy93/dashy)
|
||||
|
||||
**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!
|
||||
### ✨ Usage
|
||||
|
||||
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:
|
||||
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.*
|
||||
|
||||
```sh
|
||||
$ curl -O https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/example.png
|
||||
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
|
||||
wget https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/example.png
|
||||
```
|
||||
|
||||
**💡 Tip!** Access Dashboard Icons online faster via `https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/example.png`, replacing `example` with the icon name!
|
||||
|
||||
## 🎨 Icons
|
||||
**⚠️ Warning!** Going to this page will load every single icon in the repository. This might cause:
|
||||
- 📉 An excessive amount of data use.
|
||||
**⚠️ Warning!** Visiting this page will load every single icon in the repository. This may cause:
|
||||
- 📉 Excessive data usage.
|
||||
- 💻 System slowdowns.
|
||||
- 🌐 Browser crashes.
|
||||
|
||||
*If your device cannot handle loading more than 1000 images, we advise to not go to this page.*
|
||||
*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 display all icons.
|
||||
➡️ Click [**here**](ICONS.md) to view all icons.
|
||||
|
||||
## 🎉 Contributing Guidelines
|
||||
Please read the [Contributing Guidelines](CONTRIBUTING.md) before contributing to this project.
|
||||
## 🎉 Contribution Guidelines
|
||||
Please review the [Contribution Guidelines](CONTRIBUTING.md) before contributing to this project.
|
||||
|
||||
## 📜 Legal
|
||||
|
||||
Please 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.
|
||||
|
||||
If you have any questions or concerns regarding the license, please contact us at contact@walkx.fyi before using or distributing the contents of this repository.
|
||||
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 walkxnl@gmail.com before using or distributing the contents of this repository.
|
||||
Reference in New Issue
Block a user