Update open-url docs to mention NSPrincipalClass

We got bit by a nasty bug today - if you change your app's info.plist `NSPrincipalClass` to something other to `AtomApplication` (We set it to NylasApplication via a bad find-replace), everything works except open-url is never fired. Add a small reference to the docs so folks know to check this key.
This commit is contained in:
Ben Gotow 2016-11-21 16:55:18 -08:00 committed by GitHub
parent 71f94c7a3a
commit 964c88a189

View file

@ -108,8 +108,9 @@ Returns:
* `event` Event
* `url` String
Emitted when the user wants to open a URL with the application. The URL scheme
must be registered to be opened by your application.
Emitted when the user wants to open a URL with the application. Your application's
Info.plist file must define the url scheme within the `CFBundleURLTypes` key, and
set `NSPrincipalClass` to `AtomApplication`.
You should call `event.preventDefault()` if you want to handle this event.