Issue #410: [docs] detail on deviceready dependency

phonegap · Dec 18, 2015 · 00e9e71 · 00e9e71
1 parent 20f489a
commit 00e9e71
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/API.md b/docs/API.md
@@ -16,6 +16,8 @@
 
 Initializes the plugin on the native side.
 
+**Note:** like all plugins you must wait until you receive the [`deviceready`](https://cordova.apache.org/docs/en/5.4.0/cordova/events/events.deviceready.html) event before calling `PushNotification.init()`.
+
 ### Returns
 
 - Instance of `PushNotification`.