doc: Update new crash-reporter API.
authorCheng Zhao <zcbenz@gmail.com>
Thu, 14 Nov 2013 05:39:44 +0000 (13:39 +0800)
committerCheng Zhao <zcbenz@gmail.com>
Thu, 14 Nov 2013 05:39:44 +0000 (13:39 +0800)
docs/api/common/crash-reporter.md

index 17493dd..b966dd4 100644 (file)
@@ -4,24 +4,19 @@ An example of automatically submitting crash reporters to remote server:
 
 ```javascript
 crashReporter = require('crash-reporter');
-crashReporter.setProductName('YourName');
-crashReporter.setCompanyName('YourCompany');
-crashReporter.setSubmissionUrl('https://your-domain.com/url-to-submit');
-crashReporter.setAutoSubmit(true);
+crashReporter.start({
+  productName: 'YourName',
+  companyName: 'YourCompany',
+  submitUrl: 'https://your-domain.com/url-to-submit',
+  autoSubmit: true
+});
 ```
 
-## crashReporter.setProductName(product)
+## crashReporter.start(options)
 
-* `product` String
-
-## crashReporter.setCompanyName(company)
-
-* `company` String
-
-## crashReporter.setSubmissionUrl(url)
-
-* `url` String
-
-## crashReporter.setAutoSubmit(is)
-
-* `is` Boolean
+* `options` Object
+  * `productName` String
+  * `companyName` String
+  * `submitUrl` String - URL that crash reports would be sent to
+  * `autoSubmit` Boolean - Send the crash report without user interaction
+  * `ignoreSystemCrashHandler` Boolean