Skip to content

Commit 1c3f6f6

Browse files
authored
fix typo
1 parent 1d6f124 commit 1c3f6f6

File tree

1 file changed

+16
-21
lines changed

1 file changed

+16
-21
lines changed

Document-English.md

Lines changed: 16 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -52,19 +52,19 @@
5252

5353
<br />
5454

55-
<h2 id= "1">1. About <h2/>
56-
55+
## <h2 id= "1">1. About <h2/>
5756

58-
APIJSON is a JSON based application that largely simplify the process of back-end API development. It allows front-end users to get data with self-defined form.
57+
APIJSON is a JSON based internet communication protocol and an ORM library that largely simplifies the process of back-end API development. It also allows users to get data more quickly with self-defined form and fewer endpoints requests.
5958

6059
### Features:
6160
#### For getting data:
6261
You can get any data by defining the specific information you want and send it to the server.<br />
6362
You can get different types of data by making just one request to the server. It's very convenient and flexible, and dosen't require different API endpoints with multiple requests.<br />
64-
It provides CRUD(read and write), Fuzzy Search, Remote Function Calls,etc. You can also save duplicate data and improve data transmission speed as well!<br />
63+
It provides CRUD(read and write), Fuzzy Search, Remote Function Calls,etc. You can also save duplicate data, see request history,etc.<br />
64+
6565
#### For API design:
66-
APIJSON largely reduces API developers' workload by reducing most api design and document writing!<br />
67-
With APIJSON, client developers will no longer be suffered from possible errors in documents, and don't have to communicate with server developers about APIs or documents anymore.<br />
66+
APIJSON largely reduces API developers' workload by reducing most api design and documentation work.<br />
67+
With APIJSON, client developers will no longer be suffered from possible errors in documents, and it saves communication between server developers and client developers about APIs or documentations .<br />
6868
Server developers no longer need to worry about compatibility of APIs and documents with legacy apps.
6969

7070
### Examples:
@@ -156,9 +156,8 @@ Response:
156156
<p align="center" >
157157

158158

159-
<h2 id="2">2.Server-side deployment<h2/>
160-
161-
159+
## <h2 id="2">2.Server-side deployment<h2/>
160+
162161
You can use either Eclipse for JavaEE or IntelllJ IDEA Ultimate to make installation. For both, first download the project and save it to a path.
163162

164163
### <h3 id="2.1">2.1 Installing with Eclipse<h3/>
@@ -240,7 +239,7 @@ Click *Run* in the bottom.
240239

241240
<br />
242241

243-
<h2 id="3">3. Client-side deployment<h2/>
242+
## <h2 id="3">3. Client-side deployment<h2/>
244243

245244
### <h3 id="3.1">3.1 For Android<h3/>
246245

@@ -270,35 +269,31 @@ You can use either an IDE or text editor like sublime, Atom, etc. Webstorm is re
270269
While using a text editor, you just open the .html file in the APIJSON-JS folder.<br/>
271270
You can also open it with Vue javascript framework. Click [here](https://vuejs.org/) to learn more.
272271

273-
<h2 id="4">4. Contributing<h2/>
274-
272+
## <h2 id="4">4. Contributing<h2/>
275273

276274
We are always looking for more developers to help implementing new features, fix bugs, etc. Please have a look at the [open issues](https://github.com/APIJSON/APIJSON/issues) before opening a new one .<br />
277275

278276
Fork the project and send a pull request.<br />
279277

280-
Please also star the project!
278+
Please also ⭐Star the project!
281279
<br />
282280

283-
<h2 id="5">5. Versioning<h2/>
284-
281+
## <h2 id="5">5. Versioning<h2/>
285282

286283
See the latest version [here.](https://github.com/TommyLemon/APIJSON/commits/master)
287284

288285
<br />
289286

290-
<h2 id="6">6. Auhtor<h2/>
291-
287+
## <h2 id="6">6. Auhtor<h2/>
292288

293-
Check out the author's [github account!](https://github.com/TommyLemon)to see more related projects<br>
289+
Check out the author's [github account](https://github.com/TommyLemon)to see more related projects.<br>
294290

295291
If you have any questions or suggestions, you can [create an issue](https://github.com/TommyLemon/APIJSON/issues) or [send me an e-mail](mailto:[email protected]).
296292

297293
<br />
298294

299-
<h2 id="7">7. Donating<h2/>
300-
301-
295+
## <h2 id="7">7. Donating<h2/>
296+
302297
If you like this projects and want to donate for maintainance cost, or want to buy me a coffee, you can scan Wechat QR code or QQ QR code below. <br />
303298

304299
<img src="https://raw.githubusercontent.com/TommyLemon/StaticResources/master/pay/WechatPay.JPG" width="240" ><img src="https://raw.githubusercontent.com/TommyLemon/StaticResources/master/pay/QQPay.JPG" width="240" >

0 commit comments

Comments
 (0)