forked from sintaxi/phonegap
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
created a new readme file. still need to add the API docs
- Loading branch information
Showing
1 changed file
with
57 additions
and
54 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |