add missing options to a document and type definitions

rhysd · May 16, 2019 · 8131cc4 · 8131cc4
1 parent 1ce6b6a
commit 8131cc4
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -41,6 +41,7 @@ export default function openAboutWindow(info: {
     win_options?: BrowserWindowOptions;
     use_version_info?: boolean;
     show_close_button?: string;
+    win_title?: string;
 }): BrowserWindow
 ```
 
@@ -92,6 +93,8 @@ $ npm run debug
 | `product_name` | Name of the application **Optional** | string |
 | `use_version_info` | If `false`, the versions of electron, chrome, node, and v8 will not be displayed. Default is `true`. **Optional** | boolean |
 | `show_close_button` | If this is a valid string, a close button with this string be displayed. **Optional** | string |
+| `about_page_dir` | Directory path which contains `about.html` which is rendered in 'About this app' window. **Optional** | string |
+| `win_title` | Title string of the window. Default title is `About {app name}`. **Optional** | string |
 
 **Note:** If you set `use_inner_html` to `true`, please ensure that contents don't contain any untrusted external input
 in order to avoid XSS. Be careful.

diff --git a/index.d.ts b/index.d.ts
@@ -18,6 +18,7 @@ export interface AboutWindowInfo {
     use_inner_html?: boolean;
     use_version_info?: boolean;
     show_close_button?: string;
+    win_title?: string;
 }
 
 export default function openAboutWindow(into: AboutWindowInfo | string): Electron.BrowserWindow;