docs: give an example of how icons work

blood
Adasauce 4 years ago
parent 58157a1b5e
commit e9bfdd2ad0
Signed by: adasauce
GPG Key ID: B4FD3151235211CB
  1. 33
      README.md

@ -3,8 +3,6 @@
Some bash wrappers around nativefier to generate standalone electron apps and have them
installed as desktop apps.
## Usage
```
mknative
========
@ -42,6 +40,37 @@ mknative -n example-app -s https://example.com
it will look for an example-app.png file in `~/.local/share/mknative/icons/`.
Just download the icon for the site and place it there before running.
If you supply the `-i` argument, it will reach out to the favicongrabber.com API and give
you a list of things that look like icons on the home page of the domain you specify and
save it to your icons folder for you.
Here's an example of how that looks for a Plex.tv app.
```
$ mknative -s https://app.plex.tv/desktop -n plex.with.parts -i plex.tv
mknative
========
URL: https://app.plex.tv/desktop
Name: plex.with.parts
Icon Domain: plex.tv
Fetching potential icons using favicongrabber.com API (retry if fails, flaky API )...
Here's the icons I found, which would you like?
0) https://www.plex.tv/wp-content/themes/plex/assets/img/favicons/favicon-32x32.png
1) https://www.plex.tv/wp-content/themes/plex/assets/img/favicons/favicon-16x16.png
2) https://www.plex.tv/wp-content/themes/plex/assets/img/favicons/apple-touch-icon-144x144.png
3) https://www.plex.tv/wp-content/themes/plex/assets/img/favicons/apple-touch-icon-152x152.png
4) https://www.plex.tv/wp-content/themes/plex/assets/img/favicons/mstile-144x144.png
Selection: 2
getting https://www.plex.tv/wp-content/themes/plex/assets/img/favicons/apple-touch-icon-144x144.png
...
```
Then check out your application launcher for example-app.
## Uninstalling apps

Loading…
Cancel
Save