diff --git a/.github/ISSUE_TEMPLATE/request_suggest.yml b/.github/ISSUE_TEMPLATE/request_suggest.yml
index 60b880c..03bfc8c 100644
--- a/.github/ISSUE_TEMPLATE/request_suggest.yml
+++ b/.github/ISSUE_TEMPLATE/request_suggest.yml
@@ -5,12 +5,12 @@ assignees: walkxcode
body:
- type: markdown
attributes:
- value: "Thank you for your interest in contributing to our icon repository! To ensure that everything runs smoothly, we've set out some guidelines for contributors.\n## ๐ Icon Specifications\n\n- Each icon should include both a **PNG** and **SVG** version. If an **SVG** cannot be found, then only a **PNG** version is required.\n\n- Each icon should be in **PNG** format and have a height of exactly **512px**. Width does not matter. โ๏ธ(No upscales! If the correct size cannot be found, a smaller height will be accepted.)\n\n- Icons should be named after their full name, using the [Kebab Case](https://wiki.c2.com/?KebabCase) naming convention. For example, \"Facebook Messenger\" should be named `facebook-messenger.png`.\n\n- Monochrome icons should default to a dark version. Light versions should be named `service-light.png`. If a light version is not available, use [https://pinetools.com/colorize-image](https://pinetools.com/colorize-image) to change its color.\n"
+ value: "Thank you for your interest in contributing to our icon repository! To ensure smooth collaboration, we've established clear guidelines for contributors.\n## ๐ Icon Specifications\n\n- Icons should be provided in both `PNG` and `SVG` formats. Formats like `JPEG` or `WEBP` will not be accepted.\n - If an `SVG` version is unavailable, a `PNG` version alone suffices.\n - Conversely, if a `PNG` version is missing, it can be generated using [Ezgif SVG to PNG](https://github.com/walkxcode/dashboard-icons/blob/main/CONTRIBUTING.md#-converting-svg-to-png).\n\n- `PNG` files should have a height of exactly `512px` Width can vary, but a 1:1 aspect ratio is preferred.\n - โ Exceptions for upscales will be made only if the correct or a downscaled version cannot be obtained.\n - Downsizing can be accomplished using [iLoveIMG Resize](https://github.com/walkxcode/dashboard-icons/blob/main/CONTRIBUTING.md#-downscaling-pngs).\n\n- Icons should be named using the [Kebab Case](https://wiki.c2.com/?KebabCase) convention, reflecting their full name. For instance, \"Facebook Messenger\" should be named `facebook-messenger.png`.\n\n- Monochrome icons should default to a dark version. Light versions should be named `name-light.png`. If a light version is absent, utilize [https://pinetools.com/colorize-image](https://pinetools.com/colorize-image) to adjust its color.\n"
- type: checkboxes
attributes:
label: Contribution Guidelines
options:
- - label: I have read and agree to the [Contribution Guidelines](https://github.com/walkxcode/dashboard-icons/blob/main/CONTRIBUTING.md)
+ - label: I have read and agree to the [Contribution Guidelines](https://github.com/walkxcode/dashboard-icons/blob/main/CONTRIBUTING.md)
required: true
- type: textarea
id: icon-name
diff --git a/.github/workflows/icons-page-generation.yml b/.github/workflows/icons-page-generation.yml
index 84ac0cb..a80d500 100644
--- a/.github/workflows/icons-page-generation.yml
+++ b/.github/workflows/icons-page-generation.yml
@@ -28,5 +28,5 @@ jobs:
git config --global user.email "noreply@walkx.fyi"
git config --global user.name "Dashboard Icons Bot"
git add -A
- git commit -m ":rocket: Generates ICONS" || exit 0
+ git commit -m ":construction_worker: Generates ICONS.md" || exit 0
git push
diff --git a/.github/workflows/png-compression.yml b/.github/workflows/png-compression.yml
index 426a874..a742868 100644
--- a/.github/workflows/png-compression.yml
+++ b/.github/workflows/png-compression.yml
@@ -2,9 +2,9 @@ name: ๐๏ธ PNG Compression
on:
schedule:
- - cron: '0 0 * * 0'
+ - cron: "0 0 * * 0"
workflow_dispatch:
-
+
jobs:
compress-images:
runs-on: ubuntu-latest
@@ -15,18 +15,18 @@ jobs:
run: |
sudo apt-get update
sudo apt-get install -y zopfli
-
+
- name: Compress PNGs
run: |
- echo "๐ผ๏ธ Compressing PNGs..."
+ echo "Compressing PNGs..."
find png/ -iname "*.png" -print0 | xargs -0 -P 4 -I{} sh -c 'echo "Compressing {}"; zopflipng -y {} {}' || true
-
+
- name: Load to GitHub
run: |-
git diff
git config --global user.email "noreply@walkx.fyi"
git config --global user.name "Dashboard Icons Bot"
git add -A
- git commit -m ":clamp: Compresses PNGs" || exit 0
+ git commit -m ":children_crossing: Compresses PNGs" || exit 0
git pull --ff-only
git push
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
index 77acbfc..ac0e38e 100644
--- a/CODE_OF_CONDUCT.md
+++ b/CODE_OF_CONDUCT.md
@@ -12,7 +12,7 @@ Harassment, intimidation, discrimination, or any other inappropriate conduct or
## ๐ข Reporting
-If you believe someone is violating the code of conduct, please report it immediately to contact@walkx.fyi. All reports will be reviewed and investigated promptly and confidentially.
+If you believe someone is violating the code of conduct, please report it immediately to walkxnl@gmail.com. All reports will be reviewed and investigated promptly and confidentially.
## ๐จ Consequences
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9c09a12..cae5610 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,32 +1,50 @@
-# ๐ Contributing Guidelines
+# ๐ค Contribution Guidelines
-Thank you for your interest in contributing to our icon repository! To ensure that everything runs smoothly, we've set out some guidelines for contributors.
+We appreciate your interest in contributing to our icon repository! To ensure smooth collaboration, kindly adhere to the following guidelines:
## ๐ Icon Specifications
-- Each icon should include both a **PNG** and **SVG** version. If an **SVG** cannot be found, then only a **PNG** version is required.
-- Each icon should be in **PNG** format and have a height of exactly **512px**. Width does not matter. โ๏ธ(No upscales! If the correct size cannot be found, a smaller height will be accepted.)
-- Icons should be named after their full name, using the [Kebab Case](https://wiki.c2.com/?KebabCase) naming convention. For example, "Facebook Messenger" should be named `facebook-messenger.png`.
-- Monochrome icons should default to a dark version. Light versions should be named `service-light.png`. If a light version is not available, use [https://pinetools.com/colorize-image](https://pinetools.com/colorize-image) to change its color.
-
+- Icons should be provided in both `PNG` and `SVG` formats. Other formats like `JPEG` or `WEBP` will not be accepted.
+ - In cases where an `SVG` version is unavailable, a `PNG` version alone suffices.
+ - Conversely, if a `PNG` version is missing, it can be generated using [Ezgif SVG to PNG](#-converting-svg-to-png).
+- `PNG`s should maintain a height of exactly `512px`, while width can vary. However, a 1:1 aspect ratio is preferred.
+ - โ Avoid upscales! Exceptions will be made only if the correct or a downscaled version cannot be obtained.
+ - Downsizing can be accomplished using [iLoveIMG Resize](#-downscaling-pngs).
+- Icons should be named using the [Kebab Case](https://wiki.c2.com/?KebabCase) convention, reflecting their full name. For instance, "Facebook Messenger" should be named `facebook-messenger.png`.
+- Icons that are predominantly monochrome should default to a dark version. Light versions should be named `name-light.png`. If a light version is not available, use [https://pinetools.com/colorize-image](https://pinetools.com/colorize-image) to adjust its color.
## ๐ป Gitmoji Commits
-- Please use [Gitmoji](https://gitmoji.dev/) in your commit messages. This helps us keep our commit history clear and easy to understand. For example, you might use the `๐ฑ` emoji for a commit that updates an icon's color, or the `๐` emoji for a commit that updates the documentation.
+- Use [Gitmoji](https://gitmoji.dev/) in your commit messages. This helps us keep our commit history clear and easy to understand. For instance, use the `๐ฑ` emoji for commits related to updating icon colors, and `๐` for documentation updates.
+## ๐ Converting SVG to PNG
+
+1. Go to https://ezgif.com/svg-to-png.
+2. Upload the `SVG` file by clicking "Upload".
+3. Set the "Height (optional)" field to `512`, leaving other settings as default.
+4. Click "Convert to PNG!".
+5. Click "Save" located at the bottom right under the converted image.
+
+## โคต๏ธ Downscaling PNGs
+
+1. Go to https://www.iloveimg.com/resize-image.
+2. Upload the `PNG` file(s).
+3. Adjust the "Height (px)" field to `512`, leaving other settings as default.
+4. Click "Resize IMAGES".
+5. Download the resized icon(s).
## ๐ค Contributing
-1. Fork the repository to your own GitHub account.
+1. Fork the repository to your GitHub account.
2. Clone the repository to your local machine.
-3. Add your icon(s) to the repository, following the specifications listed above.
+3. Add your icon(s) to the repository, adhering to the specified guidelines.
4. Push your changes to your fork.
5. Create a pull request in the main repository.
## ๐จ Code of Conduct
-Please note that by contributing to this repository, you agree to abide by our code of conduct, which can be found in the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file in the repository.
+Kindly note that contributing to this repository necessitates adherence to our code of conduct, outlined in the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) file within the repository.
---
-If you have any questions or concerns, please don't hesitate to reach out to me at contact@walkx.fyi. Happy contributing! ๐
+Should you have any queries or concerns, feel free to reach out to me using walkxnl@gmail.com. Happy contributing! ๐
diff --git a/ICONS.md b/ICONS.md
index 9814063..ebc9ac6 100644
--- a/ICONS.md
+++ b/ICONS.md
@@ -1,21 +1,21 @@
diff --git a/LICENSE b/LICENSE
index 78201be..05a87db 100644
--- a/LICENSE
+++ b/LICENSE
@@ -2,11 +2,11 @@
Unless otherwise indicated, all images and assets in this repository, including product names, trademarks, and registered trademarks, are the property of their respective owners. These images and assets are used for identification purposes only and their use does not imply endorsement.
---------------------------------
+---
**Code and Documentation**
-Copyright (c) 2023 Bjorn Lammers
+Copyright (c) 2024 Bjorn Lammers (walkxcode)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
diff --git a/README.md b/README.md
index ff6448e..e82d099 100644
--- a/README.md
+++ b/README.md
@@ -1,79 +1,73 @@
-
# ๐ 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.
\ No newline at end of file
diff --git a/config/TEMPLATE.md b/config/TEMPLATE.md
index b1a04b1..d6e86bd 100644
--- a/config/TEMPLATE.md
+++ b/config/TEMPLATE.md
@@ -1,14 +1,14 @@
+
