CB-7977 Mention deviceready in plugin docs
diff --git a/doc/index.md b/doc/index.md
index c929cb0..442849c 100644
--- a/doc/index.md
+++ b/doc/index.md
@@ -19,7 +19,15 @@
# org.apache.cordova.dialogs
-This plugin provides access to some native dialog UI elements.
+This plugin provides access to some native dialog UI elements
+via a global `navigator.notification` object.
+
+Although the object is attached to the global scoped `navigator`, it is not available until after the `deviceready` event.
+
+ document.addEventListener("deviceready", onDeviceReady, false);
+ function onDeviceReady() {
+ console.log(navigator.notification);
+ }
## Installation
