Docs: link to Docker Hub repo, lighten README and move some stuff to CATALOG

2024-12-22 18:18:55 +00:00 · 2022-01-06 14:09:15 -05:00 · 2022-01-06 14:09:15 -05:00 · 8d05fc9b8b
commit 8d05fc9b8b
parent e4ab2dba5b
2 changed files with 90 additions and 85 deletions
--- a/CATALOG.md
+++ b/CATALOG.md
@ -3,7 +3,7 @@
 Below you'll find a list of build commands contributed by the Nativefier community. They are here as examples, to help you nativefy "complicated" apps that need a bit of elbow grease to work. We need your help to enrich it, as long as you follow these two guidelines:

 1. Only add sites that require something special! No need to document here that `simplesite.com` works with a simple `nativefier simplesite.com` 🙂.
-2. Please add commands with the *strict necessary* to make an app work. For example,
+2. Please add commands with the _strict necessary_ to make an app work. For example,
   - Yes to mention that `--widevine` or some `--browserwindow-options` are necessary...
   - ... but don't add other flags that are pure personal preference (e.g. `--disable-dev-tools` or `--disk-cache-size`).

@ -53,6 +53,25 @@ nativefier 'https://play.hbomax.com/'

 Note: as for Udemy, `--widevine` + [app signing](https://github.com/nativefier/nativefier/issues/1147#issuecomment-828750362) is necessary.

+## WhatsApp
+
+```sh
+nativefier 'https://web.whatsapp.com/'
+  --inject whatsapp.js
+```
+
+With this `--inject` in `whatsapp.js` (and maybe more, see [#1112](https://github.com/nativefier/nativefier/issues/1112)):
+
+```javascript
+if ('serviceWorker' in navigator) {
+  caches.keys().then(function (cacheNames) {
+    cacheNames.forEach(function (cacheName) {
+      caches.delete(cacheName);
+    });
+  });
+}
+```
+
 ## Spotify

 ```sh
@ -66,10 +85,11 @@ Notes:

 - You might have to pass `--user-agent firefox` to circumvent Spotify's detection that your browser isn't a real Chrome. But [maybe not](https://github.com/nativefier/nativefier/issues/1195#issuecomment-855003776).
 - [Inject](https://github.com/nativefier/nativefier/blob/master/API.md#inject) the following javascript as `spotify.js` to prevent "Unsupported Browser" messages.
+
 ```javascript
 function dontShowBrowserNoticePage() {
  const browserNotice = document.getElementById('browser-support-notice');
-    console.log({ browserNotice })
+  console.log({ browserNotice });
  if (browserNotice) {
    // When Spotify displays the browser notice, it's not just the notice,
    // but the entire page is focused on not allowing you to proceed.
@ -94,28 +114,34 @@ function nukeWorkers() {
    });
    navigator.serviceWorker.getRegistrations().then((registrations) => {
      registrations.forEach((worker) =>
-                worker.unregister().then((u) => {
+        worker
+          .unregister()
+          .then((u) => {
            console.debug('Unregistered worker', worker);
            reload();
-                }).catch((e) =>
-                    console.error('Unable to unregister worker', error, { worker })
-                )
+          })
+          .catch((e) =>
+            console.error('Unable to unregister worker', error, { worker }),
+          ),
      );
    });
  }
 }

 document.addEventListener('DOMContentLoaded', () => {
-    nukeWorkers()
+  nukeWorkers();
 });

-if (document.readyState === "interactive") {
+if (document.readyState === 'interactive') {
  nukeWorkers();
 }
 ```

 - It is also required to [sign the app](https://github.com/nativefier/nativefier/blob/master/API.md#widevine), or many songs will not play.
 - To hide all download links (as if you were in the actual app), [inject](https://github.com/nativefier/nativefier/blob/master/API.md#inject) the following CSS as `spotify.css`:
+
 ```css
-a[href="/download"] { display: none; }
+a[href='/download'] {
+  display: none;
+}
 ```
--- a/README.md
+++ b/README.md
@ -54,25 +54,26 @@ to learn about other command-line flags usable to configure the packaged app.
 To have high-resolution icons used by default for an app/domain, please
 contribute to the [icon repository](https://github.com/nativefier/nativefier-icons)!

-### Build Commands Catalog
+### Catalog

-For a list of build commands contributed by the nativefier community take a look at the [CATALOG.md file](CATALOG.md)
+For a list of build commands contributed by the Nativefier community, see [CATALOG.md file](CATALOG.md).

-## Usage with Docker
+## Docker

-Nativefier is also usable from Docker.
- Pull the latest stable image from Docker Hub: `docker pull nativefier/nativefier`
- ... or build the image yourself: `docker build -t local/nativefier .`
+Nativefier is also usable from Docker:
+
+- Pull the image from [Docker Hub](https://hub.docker.com/r/nativefier/nativefier): `docker pull nativefier/nativefier`
+- ... or build it yourself: `docker build -t local/nativefier .`
  (in this case, replace `nativefier/` in the below examples with `local/`)

 By default, the command `nativefier --help` will be executed.
-To build e.g. a Gmail nativefier app to a writable local `~/nativefier-apps`,
+To build e.g. a Gmail app to a writable local `~/nativefier-apps`,

 ```bash
 docker run --rm -v ~/nativefier-apps:/target/ nativefier/nativefier https://mail.google.com/ /target/
 ```

-You can pass Nativefier flags, and mount volumes to provide local files. For example, to use an icon,
+You can pass Nativefier flags, and mount volumes to pass local files. E.g. to use an icon,

 ```bash
 docker run --rm -v ~/my-icons-folder/:/src -v $TARGET-PATH:/target nativefier/nativefier --icon /src/icon.png --name whatsApp -p linux -a x64 https://web.whatsapp.com/ /target/
@ -81,59 +82,37 @@ docker run --rm -v ~/my-icons-folder/:/src -v $TARGET-PATH:/target nativefier/na
 ## Development

 Help welcome on [bugs](https://github.com/nativefier/nativefier/issues?q=is%3Aopen+is%3Aissue+label%3Abug) and
-[feature requests](https://github.com/nativefier/nativefier/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request).
+[feature requests](https://github.com/nativefier/nativefier/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request)!

-[Developer / build docs](HACKING.md), [API documentation](API.md), 
+[Developer / build / hacking docs](HACKING.md), [API documentation](API.md),
 [Changelog](CHANGELOG.md).

 ## License

-[MIT](LICENSE.md)
+[MIT](LICENSE.md).

 ## Troubleshooting

-Before submitting a question or bug report, please ensure you have read through these common issues and see if you can resolve the problem on your own. If you still encounter issues after trying these steps, or you don't see something similar to your issue listed, please submit a [bug report](https://github.com/nativefier/nativefier/issues/new?assignees=&labels=bug&template=bug_report.md).
+Generally, see [Catalog](CATALOG.md) for ideas & workarounds, and search in existing issues.

-Take a look a the [Build Command Catalog](CATALOG.md) as a working command for your application may already exist there.
+### Site says I use an old/unsupported browser

-### I am trying to use Nativefier to build an app for a site that tells me I have an old/unsupported browser.
+Some sites intentionally block Nativefier (or similar) apps, e.g. [Google](https://github.com/nativefier/nativefier/issues/831) and [WhatsApp](https://github.com/nativefier/nativefier/issues/1112).

-This issue comes up for sites that do not wish to support an app made with Nativefier or similar technologies (such as [Google](https://github.com/nativefier/nativefier/issues/831) and [WhatsApp](https://github.com/nativefier/nativefier/issues/1112))
+First, try setting the [`--user-agent`](https://github.com/nativefier/nativefier/blob/master/API.md#user-agent) to `firefox` or `safari`.

-#### Troubleshooting Steps
+If still broken, see [Catalog](CATALOG.md) for ideas & workarounds, and search in existing issues.

-1. First try setting the [`--user-agent`](https://github.com/nativefier/nativefier/blob/master/API.md#user-agent) to something different. Try using the value you would get at [https://www.whatismybrowser.com/detect/what-is-my-user-agent] and use your current browser's user agent.
-2. If this doesn't work, the site (such as WhatsApp) may be using a service worker to analyze the app and detect. You can disable the service worker cache by doing the following, which is a known fix for WhatsApp:
-    1.  Create a javascript file containing the following snippet:
-        ```javascript
-        if ('serviceWorker' in navigator) {
-            caches.keys().then(function (cacheNames) {
-                cacheNames.forEach(function (cacheName) {
-                    caches.delete(cacheName);
-                });
-            });
-        }
-        ```
-    2. Inject the javascript file into your app when generating it with the [`--inject`](https://github.com/nativefier/nativefier/blob/master/API.md#inject) argument.
-
-### I am trying to use Nativefier to build an app for a site with video, but the video won't play.
+### Videos won't play

 This issue comes up for certain sites like [HBO Max](https://github.com/nativefier/nativefier/issues/1153) and [Udemy](https://github.com/nativefier/nativefier/issues/1147).

-#### Troubleshooting Steps
+First, try our [`--widevine` flag](API.md#widevine).

-1. First try using the [`--widevine`](https://github.com/nativefier/nativefier/blob/master/API.md#widevine) argument when building the app. This uses the [Castlabs version of Electron](https://github.com/castlabs/electron-releases) which allows the playback of DRM enabled video.
-2. If this doesn't work, the site may require your app to be signed for `--widevine` to work. See the [Castlabs documentation](https://github.com/castlabs/electron-releases/wiki/EVS) on using their application signing service to sign the application.
+If still broken, see [Catalog](CATALOG.md) for ideas & workarounds, and search in existing issues.

-### I am trying different options to Nativefier to experiment with, but noticing that sometimes things cache between rebuilds of my app.
+### Settings cached between app rebuilds

 This issue can occur because the cache of the app and the app itself are kept separate by default. You can try clearing out the cache.

-#### Troubleshooting Steps
-
-1. Delete your app's cache, which can be found under the folder `<your_app_name_lower_case>-nativefier-<random_id>` in your OS's app data directory
-    - `<your_app_name_lower_case>` represents the lowercase version of your app's name. E.g., GitHub would be `github`.
-    - `<random_id>` represents a randomly generated id for your app. Open the containing folder to see what it may be.
-2. For Linux, the app data directory is `$XDG_CONFIG_HOME` or `~/.config`
-3. For MacOS, the app data directory is `~/Library/Application\ Support/`
-4. For Windows, the app data directory is `%APPDATA%`
+Try delete your app's cache, which can be found in `<your_app_name_lower_case>-nativefier-<random_id>` in your OS's "App Data" directory (for Linux: `$XDG_CONFIG_HOME` or `~/.config` , for MacOS: `~/Library/Application Support/` , for Windows: `%APPDATA%` or `C:\Users\yourprofile\AppData\Roaming`)