diff --git a/README.md b/README.md
index 096f001..f9f970d 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,17 @@
-l## JPush PhoneGap Plugin ##
+## JPush PhoneGap Plugin ##
+
+jpush-phonegap-plugin 支持 iOS,Android 的推送插件。
+
+**功能特性:**
+>+ 发送推送通知
++ 发送推送自定义消息
++ 设置推送标签和别名
++ 设置角标(iOS)
+
+*如需要 IM 功能插件,请关注[jmessage-phonegap-plugin](https://github.com/jpush/jmessage-phonegap-plugin)*
+## 安装 ##
###准备工作
1. cordova create 文件夹名字 包名 应用名字
@@ -19,30 +30,32 @@ l## JPush PhoneGap Plugin ##
###Cordova CLI/Phonegap 安装 Android & iOS
-3. 使用git命令将jpush phonegap插件下载的本地,将这个目录标记为`$JPUSH_PLUGIN_DIR`
-
- git clone https://github.com/jpush/jpush-phonegap-plugin.git
+1). 安装JPush PhoneGap Plugin。 有两种方法。
+
+方法一: 在线安装
+
+ cordova plugin add https://github.com/jpush/jpush-phonegap-plugin.git --variable API_KEY=your_jpush_appkey
+
+方法二:下载到本地再安装
+
+使用git命令将jpush phonegap插件下载的本地,将这个目录标记为`$JPUSH_PLUGIN_DIR`
-4. 将`$JPUSH_PLUGIN_DIR/plugin.xml`文件中的AppKey替换为在Portal上注册该应用的的Key,例如(9fed5bcb7b9b87413678c407)
-
-
-
-4. 打开`$JPUSH_PLUGIN_DIR/src/ios/PushConfig.plist`文件将文件中的`7d431e42dfa6a6d693ac2d04`替换为在Portal上注册该应用的的Key,例如(9fed5bcb7b9b87413678c407)
-
-
-5. 在`$JPUSH_PLUGIN_DIR/src/android/JPushPlugin.java` 文件`import your.package.name.R`替换为在Portal上注册该应用的包名,例如(com.thi.pushtest)
+ git clone https://github.com/jpush/jpush-phonegap-plugin.git
+ cordova plugin add $JPUSH_PLUGIN_DIR --variable API_KEY=your_jpush_appkey
-6. cordova cli 添加jpush phonegap插件和依赖的device插件:
- cordova plugin add $JPUSH_PLUGIN_DIR
- cordova plugin add org.apache.cordova.device
-
-7. 在js中调用函数,初始化jpush sdk
+2). 安装org.apache.cordova.device
+
+ cordova plugin add org.apache.cordova.device
+
+
+3). 在js中调用函数,初始化jpush sdk
+
+ window.plugins.jPushPlugin.init();
+ //由于phonegap插件采用了Lazy load的特性, 所以这里建议在js文件能执行的最开始就加
- window.plugins.jPushPlugin.init();
- //由于phonegap插件采用了Lazy load的特性, 所以这里建议在js文件能执行的最开始就加
### Android 手工安装
@@ -66,12 +79,6 @@ l## JPush PhoneGap Plugin ##
该项目基于cordova实现,目前无法使用'phonegap build'云服务进行打包,建议使用本地环境进行打包
-###常见错误
-1. androd
-
- eclipse中phonegap工程import之后出现:`Type CallbackContext cannot be resolved to a type`
- 解决方案:eclipse中右键单击工程名,Build Path->Config Build Path->Projects->选中 工程名称-CordovaLib->点击 add
-
### API说明
插件的API集中在JPushPlugin.js文件中,这个文件的位置如下
@@ -186,5 +193,20 @@ l## JPush PhoneGap Plugin ##
[Android API详细说明](document/Android_detail_api.md)
+###常见问题
+
+####1. androd
+
+ eclipse中phonegap工程import之后出现:`Type CallbackContext cannot be resolved to a type`
+ 解决方案:eclipse中右键单击工程名,Build Path->Config Build Path->Projects->选中 工程名称-CordovaLib->点击 add
+
+####2. iOS 设置/修改 APP_KEY
+
+ 在PushConfig.plist 中修改。PushConfig.plist 其他值说明:
+ CHANNEL 渠道标识
+ IsProduction 是否生产环境(暂未启用)
+
+
+
###更多
[JPush官网文档](http://docs.jpush.io/)
\ No newline at end of file
diff --git a/document/Common_detail_api.md b/document/Common_detail_api.md
index b1900c0..c9a1329 100644
--- a/document/Common_detail_api.md
+++ b/document/Common_detail_api.md
@@ -271,7 +271,7 @@ ps:点击通知后传递的json object 保存在window.plugins.jPushPlugin.ope
#### event - jpush.receiveNotification
-点击通知进入应用程序时会出发改事件
+点击通知进入应用程序时会触发该事件
#####代码示例
diff --git a/document/iOS_detail_api.md b/document/iOS_detail_api.md
index 3e25d19..4c79028 100644
--- a/document/iOS_detail_api.md
+++ b/document/iOS_detail_api.md
@@ -52,7 +52,8 @@ duration 自定义的页面时间
### 设置Badge
#### API - setBadge,resetBadge
-badge是iOS用来标记应用程序状态的一个数字,出现在程序图标右上角。 JPush封装badge功能,允许应用上传badge值至JPush服务器,由JPush后台帮助管理每个用户所对应的推送badge值,简化了设置推送badge的操作。
+ JPush封装badge功能,允许应用上传badge值至JPush服务器,由JPush后台帮助管理每个用户所对应的推送badge值,简化了设置推送badge的操作。
+(本接口不会直接改变应用本地的角标值. 要修改本地badege值,使用 setApplicationIconBadgeNumber)
实际应用中,开发者可以直接对badge值做增减操作,无需自己维护用户与badge值之间的对应关系。
##### 接口定义
@@ -74,6 +75,7 @@ value 取值范围:[0,99999]
#### API - setApplicationIconBadgeNumber
+本接口直接改变应用本地的角标值.
设置iOS的角标,当设置badge=0时为清除角标
##### 接口定义
@@ -92,6 +94,27 @@ value 取值范围:[0,99999]
}
+#### API - getApplicationIconBadgeNumber
+
+获取iOS的角标值
+
+##### 接口定义
+
+ window.plugins.jPushPlugin.getApplicationIconBadgeNumber(callback)
+
+##### 参数说明
+
+- callback 回调函数
+
+#####代码示例
+```
+
+window.plugins.jPushPlugin.getApplicationIconBadgeNumber(function(data){
+ console.log(data);
+ });
+
+```
+
### 本地通知
### 日志等级设置
diff --git a/example/index.html b/example/index.html
index b7f1520..28a093a 100644
--- a/example/index.html
+++ b/example/index.html
@@ -1,210 +1,224 @@
-
-
-
-
- Phonegap Sample App
-
-
-
-
-
+
+
+
-
-
-