From cd09e1316d567f92ee1afae32ec6d6da36b37cc6 Mon Sep 17 00:00:00 2001
From: imndx <imndxx@gmail.com>
Date: Tue, 22 Jan 2019 21:54:28 +0800
Subject: [PATCH] update readme

---
 README.md | 26 ++++++++++++++++++++++++--
 1 file changed, 24 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 897a6c8..a14eefb 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,24 @@
-# push_server
-wildfire chat push server
+# 野火IM 推送服务
+作为野火IM的推送服务的演示，支持小米、华为、魅族和苹果apns。
+
+#### 编译
+```
+mvn package
+```
+
+#### 修改配置
+本演示服务有5个配置文件，分别是```application.properties```, ```apns.properties```, ```meizu.properties```, ```hms.properties```和```xiaomi.properties``` 。
+分别配置服务的端口和相关推送的配置。
+请直接在工程的resource目录下修改打包进工程。或者放到jar包所在的目录下的```config```目录下。
+
+#### 运行
+```
+nohup java -jar push-XXXXX.jar > push.log 2>&1 &
+```
+
+#### 鸣谢
+1. [TypeBuilder](https://github.com/ikidou/TypeBuilder) 一个用于生成泛型的简易Builder
+
+#### LICENSE
+UNDER MIT LICENSE. 详情见LICENSE文件
+