README updates
diff --git a/README.md b/README.md
index f112299..2c62fa6 100755
--- a/README.md
+++ b/README.md
@@ -4,37 +4,37 @@
Pre-requisites
-----------------------------------------------------
-You should have VirtualBox (virtual machine software which runs the Palm emulator) and the webOS SDK installed. Both of these can be found at http://developer.palm.com/index.php?option=com_content&view=article&id=1545.
+You should have VirtualBox (virtual machine software which runs the Palm emulator) and the webOS SDK installed. Both of these can be found at [Palm's Developer Site](http://developer.palm.com/index.php?option=com_content&view=article&id=1545).
Set up your environment and install the skeleton app
-----------------------------------------------------
Open a terminal, and navigate to the root PhoneGap webOS folder (where this readme.md file is located). A Makefile resides here; running make here will package your application, and install it to either the emulator, or the device. Or you can run make on individual target tasks:
- - make js - builds phonegap.js from source javascript files to libs/phonegap.js
- - make copy_js - copies libs/phonegap.js to framework/phonegap.js - modify this path if you want phonegap.js in another location
- - make package - builds the webOS app (located in framework/) into an webOS .ipk installer package in the phonegap_root/palm/ folder
- - make deploy - installs the .ipk package to a device if detected, otherwise the emulator if its running
+ - `make js` - builds phonegap.js from source javascript files to libs/phonegap.js
+ - `make copy_js` - copies libs/phonegap.js to framework/phonegap.js - modify this path if you want phonegap.js in another location
+ - `make package` - builds the webOS app (located in framework/) into an webOS .ipk installer package in the phonegap_root/palm/ folder
+ - `make deploy` - installs the .ipk package to a device if detected, otherwise the emulator if its running
If a connected webOS device is detected, the application will be installed to the device. If not, and the emulator is running, the application will be installed to the emulator. To run the emulator, search for Palm Emulator.app in the finder, and run it.
Build your PhoneGap app
-----------------------------------------------------
-Navigate to phonegap_root/webOS_new/framework/; this is where your application will reside. If you have already built a phonegap application on another platform, drop your html,js, css and assets into this folder (starting with the required index.html). Don't forget phonegap.js!
+Navigate to `phonegap_root/webOS_new/framework/`; this is where your application will reside. If you have already built a phonegap application on another platform, drop your html,js, css and assets into this folder (starting with the required index.html). Don't forget phonegap.js!
Just open framework/ in your favourite editor, build your web app, and run the appropriate make command indicated above. Edit appinfo.json to set your app id (see Notes below), version, etc.
-Also, your index.html must indicate when the device is ready to run the WebOS application. Nested within the body tag <body> of your index.html file include the following javascript code:
-
-<script>
- var phonegap = new PhoneGap();
- phonegap.deviceReady();
-</script>
+PhoneGap-webOS doesn't need to do any native initialization, but it does fire a `deviceready` that guarantees all the PhoneGap APIs are in place. You can run your code at `deviceready` like so:
-To enable a javascript debug console, open a new terminal window and type: phonegap-log app_id
-Where the app id is your app id as set in appinfo.json.
+ document.addEventListener('deviceready', function() {
+ // do cool PhoneGap things
+ }, false);
+
+To enable a javascript debug console, open a new terminal window and type:
+ phonegap-log app_id
+Where the app id is your app id as set in `appinfo.json`
This will tail your log file; it will default to the device if detected, otherwise it will read logs from the emulator.
-In your javascript, use debug.log in your javascript.
+To log from your JS code, use `console.log`
Notes & Caveats
-----------------------------------------------------
@@ -48,6 +48,6 @@
Helpful Links
-----------------------------------------------------
- - PhoneGap API Docs: docs.phonegap.com
- - PhoneGap Wiki: phonegap.pbworks.com
- - Palm webOS developer site: developer.palm.com
+ - PhoneGap API Docs: [docs.phonegap.com](http://docs.phonegap.com)
+ - PhoneGap Wiki: [phonegap.pbworks.com](http://phonegap.pbworks.com)
+ - Palm webOS developer site: [developer.palm.com](http://developer.palm.com)
