Add dependency & Update README

This commit is contained in:
Hevin 2016-06-27 10:34:16 +08:00
parent f8efb4f010
commit b01b4bf259
2 changed files with 7 additions and 19 deletions

View File

@ -10,26 +10,18 @@
> 如需要 IM 功能的插件,可关注 [jmessage-phonegap-plugin](https://github.com/jpush/jmessage-phonegap-plugin)。
## 集成步骤
集成 JPush PhoneGap Plugin 有两种方法:
### 1.首先安装 cordova device 插件
cordova plugin add cordova-plugin-device
### 2.安装 JPush PhoneGap Plugin
安装 JPush PhoneGap Plugin 有两种方法:
方法一:在线安装
通过 Cordova plugins 安装,要求 PhoneGap/Cordova CLI 5.0+
### 在线安装
- 通过 Cordova Plugins 安装,要求 PhoneGap/Cordova CLI 5.0+
cordova plugin add jpush-phonegap-plugin --variable API_KEY=your_jpush_appkey
直接通过 url 安装:
- 直接通过 url 安装:
cordova plugin add https://github.com/jpush/jpush-phonegap-plugin.git --variable API_KEY=your_jpush_appkey
方法二:下载到本地再安装
### 本地安装
使用 git 命令将 JPush PhoneGap 插件下载的本地,目录标记为 $JPUSH_PLUGIN_DIR
git clone https://github.com/jpush/jpush-phonegap-plugin.git
@ -40,12 +32,6 @@
- [iOS 手动安装文档地址](/doc/iOS_install.md)。
### 3.在 js 中调用函数,初始化 JPush
//由于 PhoneGap 插件采用了 lazy load 的特性,所以建议在 js 文件能执行的最开始就添加。
window.plugins.jPushPlugin.init();
## Demo
插件项目中包含一个简单的 Demo。若想参考可以在 /example 文件夹内找到并拷贝以下文件:

View File

@ -16,6 +16,8 @@
<engine name="cordova" version=">=3.0"/>
</engines>
<dependency id="org.apache.cordova.device" url="https://github.com/apache/cordova-plugin-device.git" />
<js-module src="www/JPushPlugin.js" name="JPushPlugin">
<clobbers target="jPushPlugin"/>
</js-module>