Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
relliv committed Jan 26, 2022
1 parent 6121cd5 commit 7aa7e47
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -118,6 +120,13 @@ Image files are named according to these titles (*see the **[reference](https://
<!-- TABLE_END -->


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

0 comments on commit 7aa7e47

Please sign in to comment.