parra/dashboard-icons
parra
/
dashboard-icons
mirror of https://github.com/walkxcode/dashboard-icons.git
1
0
Fork 0
Code

📝 Add Contibuting Guidelines and match styling 

Signed-off-by: Bjorn Lammers <walkxnl@gmail.com>
This commit is contained in:
Bjorn Lammers 2023-04-14 10:35:52 +02:00 committed by GitHub
parent 337861e9bc
commit 719094448e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
_TEMPLATE.md
View File

@ -1,35 +1,33 @@
<p align="center">
<h3 align="center"> 🟣 Dashboard Icons </h3>
<h2 align="center"> 🟣 Dashboard Icons </h3>
<p align="center">
<a href="https://www.jsdelivr.com/package/gh/walkxcode/dashboard-icons">
<img src="https://data.jsdelivr.com/v1/package/gh/walkxcode/dashboard-icons/badge/week?style=rounded" alt="JSdelivr weekly downloads badge">
<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 icons for your personal dashboard. 🚀
🚀 The best place to find icons for your dashboards.
<br />
<a href="#icons-"><strong>See the icons »</strong></a>
<a href="#-icons"><strong>👀 See the icons</strong></a>
<br />
<br />
</p>
</p>
# Table of Contents 📖
# 📖 Table of Contents
- [Getting Started 🚀](#getting-started-)
- [Dashboards 📊](#dashboards-)
- [Installation 🛠️](#installation-%EF%B8%8F)
- [Icons 🎨](#icons-)
- [Legal 📜](#legal-)
- [🚀 Getting Started](#-getting-started)
- [📊 Dashboards](#-dashboards)
- [🛠️ Installation](#️-installation)
- [🎨 Icons](#-icons)
- [🎉 Contributing Guidelines](#-contributing-guidelines)
- [📜 Legal](#-legal)
<!-- GETTING STARTED -->
# Getting Started 🚀
## 🚀 Getting Started
## Dashboards 📊
### 📊 Dashboards
There are several Dashboards available that you can use with Dashboard Icons. Here are some of the popular ones.
<br />
_Dashboards with a \* have native integration with Dashboard Icons._
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)\*
@ -40,9 +38,11 @@ _Dashboards with a \* have native integration with Dashboard Icons._
- [SUI](https://github.com/jeroenpardon/sui)
- [Homepage](https://github.com/benphelps/homepage)\*
## Installation 🛠️
**Note:** Dashboards with a \* have native integration with Dashboard Icons.
**TIP! You can access Dashboard Icons online, faster, by using `https://cdn.jsdelivr.net/gh/walkxcode/dashboard-icons/png/example.png`**
### 🛠️ 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, simply `Right click > Save image`.
@ -58,18 +58,17 @@ or
$ wget https://raw.githubusercontent.com/walkxcode/dashboard-icons/master/png/example.png -O example.png
```
## Icons 🎨
## 🎨 Icons
<details>
<summary>Click to display all icons 👀</summary>
<!-- ICONS -->
<!-- END ICONS -->
</details>
<!-- LEGAL -->
## 🎉 Contributing Guidelines
Please read the [Contributing Guidelines](CONTRIBUTING.md) before contributing to this project.
## Legal 📜
## 📜 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.