Skip to content

Commit 1143866

Browse files
authored
Create README.md
1 parent 2a44076 commit 1143866

File tree

1 file changed

+74
-0
lines changed

1 file changed

+74
-0
lines changed

README.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# jiguang-java-client-common
2+
Common lib for JiGuang Java clients.
3+
4+
## 概述
5+
6+
这是极光 java client 的公共封装开发包,为 jpush, jmessage, jsms 等 client 提供公共依赖。
7+
8+
版本更新:[Release页面](https://github.com/jpush/jiguang-java-client-common/releases)。下载更新请到这里。
9+
10+
> 非常欢迎各位开发者提交代码,贡献一份力量,review过有效的代码将会合入本项目。
11+
12+
13+
## 安装
14+
15+
### maven 方式
16+
将下边的依赖条件放到你项目的 maven pom.xml 文件里。
17+
18+
```Java
19+
<dependency>
20+
<groupId>cn.jpush.api</groupId>
21+
<artifactId>jiguang-common</artifactId>
22+
<version>0.1.1</version>
23+
</dependency>
24+
```
25+
### jar 包方式
26+
27+
请到 [Release页面](https://github.com/jpush/jiguang-java-client-common/releases)下载相应版本的发布包。
28+
29+
### 依赖包
30+
* [slf4j](http://www.slf4j.org/) / log4j (Logger)
31+
* [gson](https://code.google.com/p/google-gson/) (Google JSON Utils)
32+
* [jpush-client](https://github.com/jpush/jpush-api-java-client)
33+
34+
> 其中 slf4j 可以与 logback, log4j, commons-logging 等日志框架一起工作,可根据你的需要配置使用。
35+
36+
> jiguang-common的jar包下载。[请点击](https://github.com/jpush/jiguang-java-client-common/releases)
37+
38+
如果使用 Maven 构建项目,则需要在你的项目 pom.xml 里增加:
39+
40+
```Java
41+
<dependency>
42+
<groupId>com.google.code.gson</groupId>
43+
<artifactId>gson</artifactId>
44+
<version>2.2.4</version>
45+
</dependency>
46+
<dependency>
47+
<groupId>org.slf4j</groupId>
48+
<artifactId>slf4j-api</artifactId>
49+
<version>1.7.5</version>
50+
</dependency>
51+
<dependency>
52+
<groupId>cn.jpush.api</groupId>
53+
<artifactId>jiguang-common</artifactId>
54+
<version>0.1.1</version>
55+
</dependency>
56+
<!-- For log4j -->
57+
<dependency>
58+
<groupId>org.slf4j</groupId>
59+
<artifactId>slf4j-log4j12</artifactId>
60+
<version>1.7.5</version>
61+
</dependency>
62+
<dependency>
63+
<groupId>log4j</groupId>
64+
<artifactId>log4j</artifactId>
65+
<version>1.2.16</version>
66+
</dependency>
67+
```
68+
69+
如果不使用 Maven 构建项目,则项目 libs/ 目录下有依赖的 jar 可复制到你的项目里去。
70+
71+
## 编译源码
72+
73+
> 如果开发者想基于本项目做一些扩展的开发,或者想了解本项目源码,可以参考此章,否则可略过此章。
74+

0 commit comments

Comments
 (0)