From ae8884cfd8a3453ce3b8883e706f0c2b5af6943a Mon Sep 17 00:00:00 2001 From: Dmitriy Rozhkov Date: Wed, 27 Feb 2013 21:46:38 +0800 Subject: [PATCH] Update documentation --- README.md | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 94fbe1d..37eb9af 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,24 @@ Titanium Alloy Slide Menu Widget ================================ com.madrocket.ti.slidemenu -Demo app: https://github.com/MadRocket/slidemenu-demo +Platforms: +* ios (tested on emulator) +* android (2.3 tested on device, 4.x on emulator) -Highly inspired by [https://github.com/danielsefton/AlloySliderMenu](https://github.com/danielsefton/AlloySliderMenu) +Drawer can be created from the left, right or both. + +Demo app: https://github.com/MadRocket/slidemenu-demo (might be outdated, but you should get the idea) + +Usage +----- -In your view: +Assumptions: +* You have views/content.xml for your content +* You have views/leftmenu.xml for the left drawer +* You have views/rightmenu.xml for the right drawer +* You have views/index.xml where you going to assemble application + +In your views/index.xml: @@ -14,7 +27,7 @@ In your view: -In your controller: +In your controllers/index.js: var content = Alloy.createController('content'); $.menu.init({ @@ -37,3 +50,5 @@ In your controller: $.menu.on('close:[right]', function(e){ // Do something on close }); + +Highly inspired by [https://github.com/danielsefton/AlloySliderMenu](https://github.com/danielsefton/AlloySliderMenu)