From 7aa7e47f7ff2e740a3325308002fc26f638b1d77 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Y=C4=B1ld=C4=B1ray=20Ey=C3=BCp=20Erdo=C4=9Fan?= Date: Thu, 27 Jan 2022 01:14:01 +0300 Subject: [PATCH] Update readme --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 546a20e..b218dcb 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,8 @@ npm i @egoistdeveloper/operating-system-logos - 64x64 - 128x128 +All icons serving as `.png` format. + ## List of operating system names and custom short codes Image files are named according to these titles (*see the **[reference](https://github.com/matomo-org/device-detector/blob/228eef9a40f611a6661f1c93ee64c2c687dd3f11/Parser/OperatingSystem.php#L40)***). Current and frequently used logos defining operating systems were selected. Therefore, the version or naming differences were ignored when listing. @@ -118,6 +120,13 @@ Image files are named according to these titles (*see the **[reference](https:// +## Contribution + +When you find a lost os icon, add related folders with required sizes (*listed above*). Then add unique uppercase alpha3 short code (*also this is going to be filename*) and with name to `list.json`. Finally go to `src` folder and run `node list.js` command (*obviously nodejs must be installed*). `list.js` generates automatically preview list and updates this `readme.md` file (*this option useful for multiple icons*). All files must be `.png` format. + +Also this repo open for SVG support, waiting PR's. + + ## Legal All logos and trademarks are the property of their respective owners! If you represent the entity that has the rights over a logo and you want, for whatever reason, that logo removed from this project, **[open an issue](https://github.com/EgoistDeveloper/operating-system-logos/issues/new)** requesting its takedown and we will remove it as soon as possible.