diff --git a/README.md b/README.md index f35a9fa..a4f59d8 100644 --- a/README.md +++ b/README.md @@ -1,63 +1,39 @@ -PhoneGap Plugin for Native Menus -================================ +# Native Menu Plugin for Apache Cordova -> Add a native ToolBar, TabBar, or Menu to a PhoneGap platform. +## Overview -Summary -------- - -The phonegap-plugin-menu provides an HTML interface to define a -menu types. Each PhoneGap platform will then render the appropriate +The cordova-plugin-menu provides an HTML interface to define a +menu types. Each Cordova platform will then render the appropriate native menu from the HTML. -The implementation is loose polyfill of the [W3C HTMLMenuElement / HTMLCommandElement Specification](http://www.w3.org/TR/html5/interactive-elements.html). +The implementation is loose polyfill of the [W3C HTMLMenuElement](http://dev.w3.org/html5/spec/single-page.html#the-menu-element). -Platform Support ----------------- +## Platform Support - Android -- BlackBerry WebWorks +- BlackBerry 10 - iOS -Example -------- +## Example
-Install from Download ---------------------- - -1. Download the latest release from [phonegap-plugin-menu Downloads Page](https://github.com/nitobi/phonegap-plugin-menu/archives/master). -2. Extract the release -3. For your platform, read `INSTALL` - - `/android/INSTALL` - - `/blackberry/INSTALL` - - `/desktop/INSTALL` - - `/ios/INSTALL` - -Install from Source -------------------- +## HTML API -1. Clone or download the source code -2. Change into the source code directory -3. Run `make` to view the available options -4. Run `make dist` -5. Follow _Install from Download_ instructions - -HTML API --------- - -Menus and commands are represented purely in HTML. You can customize the menu and commands using changes their HTML attributes. +Menus and commands are defined in the DOM and represented as HTML. +Similar to other HTML elments, you can define the role of the menu and commands +with HTML attributes. During runtime, you can interact with the menu and commands +using JavaScript. <menu> API ------------------ @@ -66,9 +42,9 @@ __<menu type="toolbar">__ Create a toolbar menu. -- Android: Treats toolbar as a context menu. -- BlackBerry: Treat toolbar as a context menu. -- iOS: Creates a native ToolBar. The PhoneGap webview is repositioned below the toolbar. +- Android: Creates a title bar. +- BlackBerry: @DISCUSS +- iOS: Creates a native ToolBar. The Cordova webview is repositioned below the toolbar. __<menu type="context">__ @@ -76,7 +52,7 @@ Create a context menu. This menu is typically invoked by the device's menu butto - Android: Creates an Android menu that is invoked by the menu button. - BlackBerry: Creates a BlackBerry menu that is invoked by the menu button. -- iOS: Creates a native TabBar. The PhoneGap webview is repositioned above the TabBar. +- iOS: Creates a native TabBar. The Cordova webview is repositioned above the TabBar. __<menu label="Home">__ @@ -136,9 +112,13 @@ JavaScript API Similar to other HTML elements, you can create and manipulate `