update readme

moritzebeling · Mar 2, 2023 · 79a47f8 · 79a47f8
1 parent 829ae09
commit 79a47f8
Showing 1 changed file with 10 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Kirby Favicon
 
-This plugin will solve all your favicon worries.
+This plugin will solve all your favicon worries :)
 
 ## Installation
 
@@ -16,7 +16,7 @@ Or download/clone this repo into `site/plugins` of your Kirby project.
 
 The icon should be square, min `180x180px`, but why don’t you just do `1024x1024px` :)
 
-## More detailed setup
+## Recommended setup
 
 2. Also add a `favicon.svg`
 3. Inside your HTML `<head>` element, include the `favicon` snippet:
@@ -25,8 +25,12 @@ The icon should be square, min `180x180px`, but why don’t you just do `1024x10
 <?php snippet('favicon') ?>
 ```
 
+Usually, the `png` will be used as an app icon (eg. when you save the website as an app icon to your home screen), so I would recommend to not use transparency and add a little more space around the symbol. The `svg` will then be used by modern browsers for showing it in the tab bar, so transparency is fine and you can use the entire space as it will be shown quite small.
+
 For further control you could also add specific app icons for Apple, Android and Windows, and control all the sizes that are generated. Just have a look at the available options below.
 
+You could also set a theme color and a mask icon. The mask icon will be used in the MacBook Pro Touch Bar, so it should be simple with transparent background.
+
 ## Options
 
 ```php
@@ -125,6 +129,10 @@ When `extended` option is `true`, the following is added:
 <meta name="msapplication-TileImage" content="/media/.../favicon-144x.png">
 ```
 
+## Research
+
+To decide on a solution that fits all or most cases, I looked at many existing favicon generators and read the Mozilla docs. You can have a look at my reasearch at the repo wiki: https://github.com/moritzebeling/kirby-favicon/wiki
+
 ## Development
 
 This plugin is work in progress and I don’t provide any warranty. Use at your own risk. If you have any ideas for further developments or stumble upon any problems, please open an issue or PR. Thank you!