Skip to content

Commit 98afb97

Browse files
committed
update:read me and document
1 parent 3fc8215 commit 98afb97

File tree

4 files changed

+28
-24
lines changed

4 files changed

+28
-24
lines changed

README.en.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,10 @@ The purpose of development and implementation based on libXEngine is a cross-pla
1515
and support plugin system,dll(so,dylib)module or lua script
1616

1717
#### Why choose us
18-
19-
Support privatization deployment, free, safe, open source, controllable
18+
Support privatization deployment, free, safe, open source, controllable
19+
Dozens of information queries are completely free and open source, while similar products are all charged for API counting.
20+
Supports third-party interface data caching. It can save you the cost of other query information.
21+
It allows you to save 90% of information service costs in a year.
2022

2123
## Software feature
2224
1. permission verication
@@ -55,11 +57,12 @@ Support privatization deployment, free, safe, open source, controllable
5557
34. STUN NAT Protocol
5658
35. NTP Time Sync Protocol
5759
36. mac address vendor query
60+
37. ORC Get TEXT With image
5861

5962
## install
6063

6164
#### XEngine Evn
62-
you must install XEngine,need V8.x or above,install XEngine can be refer to xengine Readme docment
65+
you must install XEngine,need V9.x or above,install XEngine can be refer to xengine Readme docment
6366
GITEE:https://gitee.com/libxengine/libxengine
6467
GITHUB:https://github.com/libxengine/libxengine
6568

@@ -86,7 +89,7 @@ git submodule update
8689
#### Linux
8790
ubuntu:sudo apt install sudo apt install liblua5.4-dev libopencv-dev libopencv-contrib-dev libqrencode-dev
8891
centos:compile by self
89-
use makefile compile,UBUNTU22.04 x64 or RockyLinux 9 x64
92+
use makefile compile,UBUNTU24.04 x64 or RockyLinux 9 x64
9093
Run it on the terminal
9194

9295
#### Macos
@@ -129,20 +132,17 @@ information report
129132
You can refer to the project under XEngine_PluginModule to write the plugin
130133
The written plugin needs to be configured via JSON to be enabled
131134

132-
## Test Server
133-
Address:app.xyry.org,Port:5501
134-
135135
## now task
136136

137137
## other problems
138138
You can refer to the document under the docment directory. It contains API protocol and service description.
139139

140140
## Test Service
141-
Address:app.xyry.org,Port:5501
141+
Address:app.libxengine.com,Port:5501
142142
#### example
143143
For more information please refer to the documentation
144144
id information query
145-
api:http://app.xyry.org:5501/api?function=id&params1=511025198800000000
145+
api:http://app.libxengine.com:5501/api?function=id&params1=511025198800000000
146146
```json
147147
{
148148
"code":0,
@@ -162,7 +162,7 @@ api:http://app.xyry.org:5501/api?function=id&params1=511025198800000000
162162
}
163163
```
164164
bank card ver
165-
api:http://app.xyry.org:5501/api?function=bank&params1=6214832830000000
165+
api:http://app.libxengine.com:5501/api?function=bank&params1=6214832830000000
166166
```json
167167
{
168168
"code":0,
@@ -190,7 +190,7 @@ api:http://127.0.0.1:5501/api?function=translation&msg=中文翻译成英文&src
190190
}
191191
```
192192
Distributed Lock
193-
Api:http://app.xyry.org:5501/api?function=lock&params1=1000154321&params2=1
193+
Api:http://app.libxengine.com:5501/api?function=lock&params1=1000154321&params2=1
194194
```json
195195
{
196196
"code":0,
@@ -201,14 +201,14 @@ Api:http://app.xyry.org:5501/api?function=lock&params1=1000154321&params2=1
201201
}
202202
```
203203
ZIPCode
204-
Api:http://app.xyry.org:5501/api?function=zipcode&params1=0
204+
Api:http://app.libxengine.com:5501/api?function=zipcode&params1=0
205205
```json
206206
{
207207
"nZipCode":100010
208208
}
209209
```
210210
Log
211-
Api:http://app.xyry.org:5501/api?function=log&params1=1
211+
Api:http://app.libxengine.com:5501/api?function=log&params1=1
212212
```json
213213
{
214214
"tszTableName":"xengine",
@@ -222,7 +222,7 @@ Api:http://app.xyry.org:5501/api?function=log&params1=1
222222
}
223223
```
224224
Oil Query
225-
API:http://app.xyry.org:5501/api?function=oil&addr=四川
225+
API:http://app.libxengine.com:5501/api?function=oil&addr=四川
226226
```json
227227
{
228228
"code": 0,

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,10 @@ c c++ interface api service
1818
编译发布版本将只在github上面发布.
1919

2020
#### 为什么选择我们
21-
支持私有化部署,免费,安全.开源,可控
21+
支持私有化部署,免费,安全.开源,可控
22+
几十种信息查询完全免费开源,而同类型产品全是收费API计数收费
23+
支持三方接口数据缓存.可以节约你的其他查询信息费用
24+
可以让你一年节约90%信息服务费用.
2225

2326
## 软件特性
2427
1. 权限验证
@@ -57,11 +60,12 @@ c c++ interface api service
5760
34. STUN NAT协议
5861
35. NTP时间同步协议
5962
36. 支持MAC地址厂商查询
63+
37. ORC图像文本提取
6064

6165
## 安装教程
6266

6367
#### XEngine环境
64-
必须安装XEngine,版本需要V8.x或者以上版本,安装XEngine可以参考其Readme文档
68+
必须安装XEngine,版本需要V9.x或者以上版本,安装XEngine可以参考其Readme文档
6569
GITEE:https://gitee.com/libxengine/libxengine
6670
GITHUB:https://github.com/libxengine/libxengine
6771

@@ -92,7 +96,7 @@ git clone https://gitee.com/xengine/XEngine_PhoneData.git XEngine_Source/XEngine
9296
#### Linux
9397
ubuntu:sudo apt install liblua5.4-dev libopencv-dev libopencv-contrib-dev libqrencode-dev
9498
centos:需要自己编译
95-
Linux使用Makefile编译,UBUNTU22.04 x64或者RockyLinux 9 x64
99+
Linux使用Makefile编译,UBUNTU24.04 x64或者RockyLinux 9 x64
96100
在控制台运行
97101

98102
#### Macos
@@ -145,12 +149,12 @@ make FLAGS=CleanAll 清理编译
145149
你也可以观看视频教程来了解我们的代码框架情况:https://www.bilibili.com/video/BV13z421d7W8
146150

147151
## 测试服务器
148-
地址:app.xyry.org,端口:5501
152+
地址:app.libxengine.com,端口:5501
149153

150154
#### 测试接口示例
151155
更多内容请参考文档
152156
身份证查询
153-
接口:http://app.xyry.org:5501/api?function=id&params1=511025198800000000
157+
接口:http://app.libxengine.com:5501/api?function=id&params1=511025198800000000
154158
```json
155159
{
156160
"code":0,
@@ -170,7 +174,7 @@ make FLAGS=CleanAll 清理编译
170174
}
171175
```
172176
银行卡验证
173-
接口:http://app.xyry.org:5501/api?function=bank&params1=6214832830000000
177+
接口:http://app.libxengine.com:5501/api?function=bank&params1=6214832830000000
174178
```json
175179
{
176180
"code":0,
@@ -198,7 +202,7 @@ make FLAGS=CleanAll 清理编译
198202
}
199203
```
200204
分布式锁
201-
接口:http://app.xyry.org:5501/api?function=lock&params1=1000154321&params2=1
205+
接口:http://app.libxengine.com:5501/api?function=lock&params1=1000154321&params2=1
202206
```json
203207
{
204208
"code":0,
@@ -209,14 +213,14 @@ make FLAGS=CleanAll 清理编译
209213
}
210214
```
211215
行政邮编
212-
接口:http://app.xyry.org:5501/api?function=zipcode&params1=0
216+
接口:http://app.libxengine.com:5501/api?function=zipcode&params1=0
213217
```json
214218
{
215219
"nZipCode":100010
216220
}
217221
```
218222
日志操作
219-
接口:http://app.xyry.org:5501/api?function=log&params1=1
223+
接口:http://app.libxengine.com:5501/api?function=log&params1=1
220224
```json
221225
{
222226
"tszTableName":"xengine",
@@ -230,7 +234,7 @@ make FLAGS=CleanAll 清理编译
230234
}
231235
```
232236
油价查询
233-
接口:http://app.xyry.org:5501/api?function=oil&addr=四川
237+
接口:http://app.libxengine.com:5501/api?function=oil&addr=四川
234238
```json
235239
{
236240
"code": 0,

XEngine_Docment/Docment_en.docx

394 Bytes
Binary file not shown.

XEngine_Docment/Docment_zh.docx

263 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)