Skip to content

Readme: minor formatting changes #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Readme: minor formatting changes #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
976185a
Readme: Minor formatting changes
agcolom Jun 6, 2014
1cb98f3
Readme: Minor formatting changes
agcolom Jun 6, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]);`

Expand All @@ -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 ):

Expand All @@ -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
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.