From dc1b5a21307c4ccaa5a37921442c665346739829 Mon Sep 17 00:00:00 2001
From: Brock Whitten <brock@sintaxi.com>
Date: Fri, 13 Feb 2009 17:49:40 -0800
Subject: [PATCH] created a new readme file. still need to add the API docs

---
 README.md | 111 ++++++++++++++++++++++++++++--------------------------
 1 file changed, 57 insertions(+), 54 deletions(-)

diff --git a/README.md b/README.md
index 1565ce2c..2a528c14 100644
--- a/README.md
+++ b/README.md
@@ -1,64 +1,67 @@
-# GAP
 
-### open souce platform for iphone, blackberry
+PhoneGap
+=============================================================
+PhoneGap is a development tool that allows web developers to 
+take advantage of the core features in the iPhone and Android 
+SDK using JavaScript.
 
-## Javascript API
-  
-#### Geo Location
-    
-    //request location
-    getLocation();
-    
-    //GAP will invoke this function once it has the location
-    function gotLocation(lat,lon){
-    	$('lat').innerHTML = "latitude: " + lat;
-    	$('lon').innerHTML = "longitude: " + lon;
-    }
+
+Get Started
+-------------------------------------------------------------
+Download the source.
+
+    git clone git://github.com/sintaxi/phonegap.git
     
-#### Accelerometer
+PhoneGap project is separated into a native project for each 
+device, javascript files and a rakefile.
 
-    //You have instant access to the accellerometer data
-    function updateAccel(){
-    	$('accel').innerHTML = "accel: " + accelX + " " + accelY + " " + accelZ;	
-    	setTimeout(updateAccel,100);
-    }
+    phonegap
+      |- README.md
+      |- Rakefile
+      |- android/
+      |- blackberry/
+      |- iphone/
+      `- javascripts/
       
-#### Camera (pending)
+Each project has a respective README.md file. view that file 
+for detailed information on how to work with that device. PhoneGap 
+offers one unified API for accessing core functionality on all 
+devices. Where possible, phonegap follows the **HTML5 spec**.
 
-    Device.Image.getFromPhotoLibrary();
+
+API
+-------------------------------------------------------------
+
+### Device
+
+### Location
     
-#### Sound 
+### Accelerometer
     
-    // Plays a media clip from the resourse bundle. (WAV or MP3)
-  
-    Device.playSound('bird.mp3');
-  
-    
-#### Vibration
+### Contacts
+
+### Orientation
+
+### Camera
+
+### Vibrate
+
+### Sound
 
-  // Vibrates the device - Returns nothing.
+
+XUI
+-------------------------------------------------------------
+You may work with any Javascript framework within a PhoneGap 
+application. [XUI](http://xuijs.com) is the "officially preferred" 
+framework of the phonegap core team. XUI is inspired by JQuery, 
+optimized for web browsers and weighs in at 6.2k.
+
+
+Community
+-------------------------------------------------------------
+  
+  * Website - [phonegap.com](http://phonegap.com)
+  * Google Group - [groups.google.com/group/phonegap](http://groups.google.com/group/phonegap)
+  * Wiki - [phonegap.pbwiki.com/](http://phonegap.pbwiki.com/)
+  * Twitter - [twitter.com/phonegap](http://twitter.com/phonegap)
   
-  Device.vibrate();
-
-### License (MIT)
-
-#### Copyright (c) 2008 Nitobi
-
-Permission is hereby granted, free of charge, to any person obtaining  
-a copy of this software and associated documentation files (the  
-"Software"), to deal in the Software without restriction, including  
-without limitation the rights to use, copy, modify, merge, publish,  
-distribute, sublicense, and/or sell copies of the Software, and to  
-permit persons to whom the Software is furnished to do so, subject to  
-the following conditions:  
-
-The above copyright notice and this permission notice shall be  
-included in all copies or substantial portions of the Software.  
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,  
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF  
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND  
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE  
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION  
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION  
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\ No newline at end of file