@todesktop/cli 1.1.1 → 1.1.4

package/README.md

@@ -229,6 +229,16 @@ Example: `word`.
 
 If you want to register a protocol for your application (e.g. `example://`) and or support deeplinking, you will need to use this option. If your desired protocol is `example://`, you would set `"appProtocolScheme": "example"`. NOTE: these features also require additional application logic.
 
+### `asarUnpack` - (optional) boolean or array of glob patterns
+
+Default: [`**/*.node`]
+
+This option allows you to decide which files get unpacked from the asar archive. By default we unpack all native `*.node` files.
+
+If you want to unpack only files that are required to be unpacked, you can set this property to `false`.
+
+You can also specify a list of glob patterns to unpack.
+
 ### `copyright` - (optional) string
 
 Default: The `package.json` [productName](#recommendations-for-app-packagejson) / `name`.
@@ -757,6 +767,55 @@ To summarize:
 
 Note: **Do not put a token in this file**. You are specifying a literal value of `${NPM_TOKEN}`. NPM will replace the value for you. 5. Add `.npmrc` to your `appFiles` array `[".npmrc"]` in `todesktop.json`.
 
+### How do I create a staging version of my app?
+
+The easiest way to do this is to create a second app and switch the `todesktop.json` file to point to the staging app when you wish to deploy the staging app. There are a number of ways to do this. Let's do an example, save the file below as `scripts/mod-staging.js`.
+
+```js
+const path = require("path");
+const fs = require("fs");
+
+const rootDir = path.join(__dirname, "..");
+const packageJson = require(rootDir + "/package.json");
+const toDesktopJson = require(rootDir + "/todesktop.json");
+
+function modStaging() {
+  packageJson.name = "myapp-staging";
+  packageJson.productName = "My App Staging";
+
+  toDesktopJson.id = "220718gzrs4pfe8";
+  toDesktopJson.icon = "./resources/staging.png";
+  toDesktopJson.appId = "myapp.staging.app";
+
+  fs.writeFileSync(
+    rootDir + "/package.json",
+    JSON.stringify(packageJson, null, 2)
+  );
+  fs.writeFileSync(
+    rootDir + "/todesktop.json",
+    JSON.stringify(toDesktopJson, null, 2)
+  );
+}
+
+modStaging();
+```
+
+Create a similar script to revert the `todesktop.json` back to the original settings (let's save it as `scripts/mod-revert.js`).
+Then in your package.json, you could do something like this:
+
+```js
+{
+  "name": "myapp",
+  // ...
+  "scripts": {
+    "todesktop-build": "todesktop build",
+    "todesktop-staging-build": "node scripts/mod-staging.js && todesktop build && node scripts/mod-revert.js"
+  },
+}
+```
+
+Now you can run `npm run todesktop-build` to build the production app. Or you can run `npm run todesktop-staging-build` to build the staging app.
+
 ## Changelog
 
 ### v1.1.0