Renaming README

This commit is contained in:
Shaun Rowe
2012-06-06 17:56:23 +01:00
parent 1bad7c1376
commit f90643199c

View File

@@ -1,9 +1,9 @@
ExtractZipFile Phonegap Plugin for iOS
=======================================
# ExtractZipFile Phonegap Plugin for iOS #
by Shaun Rowe
This plugin allows you to extract a zip file
Adding the Plugin to your project
=================================
## Adding the Plugin to your project ##
To install the plugin, copy ZipPlugin.js to your project's www folder and include a reference to it in your html files.
@@ -14,8 +14,8 @@ Add SSZipArchive directory, ExtractZipFilePlugin.h and ExtractZipFilePlugin.m to
Add a plugin line to your cordova.plist
ExtractZipFilePlugin - String - ExtractZipFilePlugin
Using the plugin
================
## Using the plugin ##
function extractFile(fileName)
{
window.plugins.extractZipFile.extractFile(fileName,destination,win,fail);
@@ -31,6 +31,6 @@ function fail(error)
alert(error);
}
Function Call
=============
## Function Call ##
<input type="button" value="Extract Zip File" onClick="extractFile('/path/to/ZipFile.zip');"/>