diff --git a/README.md b/README.md index b49df4d..cbf823a 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ A debugging tool for jQuery Mobile Events which ties into the API docs ## Usage -Call the debugger should be done immediately after mobile library is loaded or in mobileinit handler +Call the debugger. This should be done immediately after mobile library is loaded or in mobileinit handler. `$.mobile.eventLogger([options]);` @@ -14,9 +14,9 @@ Call the debugger should be done immediately after mobile library is loaded or i ### Deprecated ( Default: false ): Show Deprecated events -### Events ( Type: Object) +### Events ( Type: Object ) -an object containing the following properties: +An object containing the following properties: ##### Page ( Default: false ): @@ -36,16 +36,16 @@ Show layout events ( updatelayout, orientationchange, throttledresize ) ##### navigation ( Default: false ): -show navigation events ( navigate, hashchange ) +Show navigation events ( navigate, hashchange ) #### showAlert ( Default: false ): -show alerts of the events and associated information +Show alerts of the events and associated information This is useful if you want to pause execution to to inspect the current state of the page or if you -on a mobile device without the ability to view the console log +are on a mobile device without the ability to view the console log. -### Widgets ( Default: empty object) +### Widgets ( Default: empty object ) -an object containing which widgets to log events for add a widget name as the prop and -set it to true to show events associated with this widget \ No newline at end of file +An object containing which widgets to log events for. Add a widget name as the prop and +set it to true to show events associated with this widget.