From 41bdaab40d3bc0f84d553b8698d188907431db86 Mon Sep 17 00:00:00 2001
From: Strawmanbobi <strawmanbobi@163.com>
Date: Sun, 4 Aug 2019 14:16:33 +0800
Subject: [PATCH] Update README.md

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/README.md b/README.md
index 9c39663..07ae703 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,21 @@
 # IRext private server
+
+Private server is a runtime that any user can deploy and access it with IRext restful web service call or SDK.
+
+### Runtime environment
+- Java runtime 1.7 or above
+- Mysql server 5.6 or above
+- Redis service
+- A Linux OS is preferred
+
+### Deploy
+- Fetch or compile libirda_decoder.so out of source code of irext/core.
+- Run following command when you fetched or compiled the private-server.jar out of the private server Spring-Boot project.
+
+```shell script
+java -jar private-server.jar
+```
+
+
+### Usage
+Please refer to Web API in http://www.irext.net/doc/ for restful webservice call.