docs: document remoteReleases/remoteToken winstaller optinos and remo…

…ve link to all tool options
electron-userland · May 3, 2016 · 92573ec · 92573ec
1 parent eebe882
commit 92573ec
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 8 deletions.
diff --git a/docs/Options.md b/docs/Options.md
@@ -88,14 +88,13 @@ MAS (Mac Application Store) specific options (in addition to `build.osx`).
 
 <a name="WinBuildOptions"></a>
 ### `.build.win`
-
-See all [windows-installer options](https://github.com/electron/windows-installer#usage).
-
 | Name | Description
 | --- | ---
-| iconUrl | <a name="WinBuildOptions-iconUrl"></a><p>*windows-only.* A URL to an ICO file to use as the application icon (displayed in Control Panel &gt; Programs and Features). Defaults to the Electron icon.</p> <p>Please note — [local icon file url is not accepted](https://github.com/atom/grunt-electron-installer/issues/73), must be https/http.</p> <ul> <li>If you don’t plan to build windows installer, you can omit it.</li> <li>If your project repository is public on GitHub, it will be <code>https://github.com/${u}/${p}/blob/master/build/icon.ico?raw=true</code> by default.</li> </ul>
+| iconUrl | <a name="WinBuildOptions-iconUrl"></a><p>A URL to an ICO file to use as the application icon (displayed in Control Panel &gt; Programs and Features). Defaults to the Electron icon.</p> <p>Please note — [local icon file url is not accepted](https://github.com/atom/grunt-electron-installer/issues/73), must be https/http.</p> <ul> <li>If you don’t plan to build windows installer, you can omit it.</li> <li>If your project repository is public on GitHub, it will be <code>https://github.com/${u}/${p}/blob/master/build/icon.ico?raw=true</code> by default.</li> </ul>
 | loadingGif | <a name="WinBuildOptions-loadingGif"></a><p>The path to a .gif file to display during install. <code>build/install-spinner.gif</code> will be used if exists (it is a recommended way to set) (otherwise [default](https://github.com/electron/windows-installer/blob/master/resources/install-spinner.gif)).</p>
 | noMsi | <a name="WinBuildOptions-noMsi"></a>Whether to create an MSI installer. Defaults to `true` (MSI is not created).
+| remoteReleases | <a name="WinBuildOptions-remoteReleases"></a>A URL to your existing updates. If given, these will be downloaded to create delta updates.
+| remoteToken | <a name="WinBuildOptions-remoteToken"></a>Authentication token for remote updates
 
 <a name="LinuxBuildOptions"></a>
 ### `.build.linux`

diff --git a/src/metadata.ts b/src/metadata.ts
@@ -209,15 +209,13 @@ export interface MasBuildOptions extends OsXBuildOptions {
 
 /*
  ### `.build.win`
-
- See all [windows-installer options](https://github.com/electron/windows-installer#usage).
  */
 export interface WinBuildOptions extends PlatformSpecificBuildOptions {
   readonly certificateFile?: string
   readonly certificatePassword?: string
 
   /*
-   *windows-only.* A URL to an ICO file to use as the application icon (displayed in Control Panel > Programs and Features). Defaults to the Electron icon.
+   A URL to an ICO file to use as the application icon (displayed in Control Panel > Programs and Features). Defaults to the Electron icon.
 
    Please note — [local icon file url is not accepted](https://github.com/atom/grunt-electron-installer/issues/73), must be https/http.
 
@@ -232,10 +230,20 @@ export interface WinBuildOptions extends PlatformSpecificBuildOptions {
    */
   readonly loadingGif?: string
 
-  /**
+  /*
    Whether to create an MSI installer. Defaults to `true` (MSI is not created).
    */
   readonly noMsi?: boolean
+
+  /*
+   A URL to your existing updates. If given, these will be downloaded to create delta updates.
+   */
+  readonly remoteReleases?: string
+
+  /*
+   Authentication token for remote updates
+   */
+  readonly remoteToken?: string
 }
 
 /*