diff --git a/docs/api/crash-reporter.md b/docs/api/crash-reporter.md index 47e3666fa440..8e4540567908 100644 --- a/docs/api/crash-reporter.md +++ b/docs/api/crash-reporter.md @@ -27,6 +27,10 @@ crashReporter.start({ * Only string properties are send correctly. * Nested objects are not supported. +**Note:** On OS X, electron uses a new `crashpad` client, which is different +with the `breakpad` on Windows and Linux. To enable crash collection feature, +you are required to call `crashReporter.start` API to initiliaze `crashpad` in Browser Process, even you only collect crash report in Renderer Process. + ## crashReporter.getLastCrashReport() Returns the date and ID of last crash report, when there was no crash report