dashboard-icons/README.md

<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>

# 📖 Table of Contents

- [📖 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

Several dashboards now offer seamless integration with Dashboard Icons. Here are some of the top choices:

- [Homepage](https://github.com/gethomepage/homepage)
- [Homarr](https://github.com/ajnart/homarr)
- [Dashy](https://github.com/Lissy93/dashy)

### ✨ Usage

To download an icon from the [icons page](#-icons), simply `Right click > Save link as`.

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
```

or

```sh
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!**  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 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.