docs: List breakpad server implementations
authorCheng Zhao <zcbenz@gmail.com>
Thu, 17 Mar 2016 13:29:32 +0000 (22:29 +0900)
committerCheng Zhao <zcbenz@gmail.com>
Thu, 17 Mar 2016 13:29:32 +0000 (22:29 +0900)
docs/api/crash-reporter.md

index 5a7ff72..64e5602 100644 (file)
@@ -16,6 +16,12 @@ crashReporter.start({
 });
 ```
 
+For setting up a server to accept and process crash reports, you can use
+following projects:
+
+* [socorro](https://github.com/mozilla/socorro)
+* [mini-breakpad-server](https://github.com/atom/mini-breakpad-server)
+
 ## Methods
 
 The `crash-reporter` module has the following methods:
@@ -66,6 +72,6 @@ The crash reporter will send the following data to the `submitURL` as a `multipa
 * `prod` String - Name of the underlying product. In this case Electron.
 * `_companyName` String - The company name in the `crashReporter` `options`
   object.
-* `upload_file_minidump` File - The crash report as file, a binary.
+* `upload_file_minidump` File - The crash report in the format of `minidump`.
 * All level one properties of the `extra` object in the `crashReporter`.
   `options` object