Fix the Typo at README

This commit is contained in:
O-GuanjieWang-O
2024-03-22 13:32:01 -04:00
parent 8ade37bbe3
commit 94547030c1
+25 -28
View File
@@ -1,37 +1,38 @@
English | [简体中文](./README_CN.md)
<a href="https://github.com/zfoo-project/zfoo"><img src="/doc/image/logo.jpg" width="30%"></a>
. Introduction of zfoo🚩
## . Introduction of zfoo🚩
-----------
- **Extremely fast, asynchronous, actor design, lock free, universal RPC framework, native GraalVM support**
- **Decentralized serialization [zfoo protocol](protocol/README.md)**supports C++ C# Go Java Javascript TypeScript Lua GDScript Python
- **High scalability**Single server deployment, microservice deployment, cluster deployment, gateway deployment
- **Decentralized serialization [zfoo protocol](protocol/README.md)**, supports C++ C# Go Java Javascript TypeScript Lua GDScript Python
- **High scalability**, Single server deployment, microservice deployment, cluster deployment, gateway deployment
- **Can be used as a game server framework or website server framework.**
Perfect work development process, complete online solution
- Spring projects, distributed projects, container projects **hot update code without
- Spring projects, distributed projects, container projects, **hot update code without
downtime** [hotswap](hotswap/src/test/java/com/zfoo/hotswap/ApplicationTest.java)
- Excel json csv configuration is automatically mapped and parsed**Online hotswap
- Excel json csv configuration is automatically mapped and parsed, **Online hotswap
configuration** [storage](storage/src/test/java/com/zfoo/storage/ApplicationTest.java)
- Automapping framework for MongoDB [orm](orm/README.md)
- Event bus [event](event/src/test/java/com/zfoo/event/ApplicationTest.java)
- Time task scheduling [scheduler](scheduler/README.md)
- **cpu, memory, hard disk, network monitoring built into the program** no code and extra tools
- **Cpu, memory, hard disk, network monitoring built into the program** no code and extra tools
required [monitor](monitor/src/test/java/com/zfoo/monitor/ApplicationTest.java)
Ⅱ. Who use this project
## Ⅱ. Who use this project
---------------
- Projects with extremely high performance requirements, such as website and game server frameworks, single server,
global server, live chat, IM system, real-time push
- Projects such as saving, development, deployment, operation and maintenance costs
- As a backend infrastructure for **GodotUnityCocosWebglH5**Network protocol supports tcp udp websocket http
- [Keep it Simple and Stupid](https://baike.baidu.com/item/KISS原则/3242383) simple configuration, lightweight code
Ⅲ. Maven dependency✨
------------
- Projects with extremely high performance requirements, such as website and game server frameworks, single server, global server, live chat, IM system, real-time push
- Projects such as saving, development, deployment, operation and maintenance costs
- As a backend infrastructure for **Godot, Unity, CocosWebgl, H5**, Network protocol supports tcp udp websocket http
- [Keep it Simple and Stupid](https://baike.baidu.com/item/KISS原则/3242383), simple configuration, lightweight code
## Ⅲ. Maven dependency✨
---------------
- Environment requirement **JDK 17+**, support **OpenJDK**, **Oracle JDK** and **native GraalVM**
@@ -53,26 +54,23 @@ Perfect work development process, complete online solution
</dependency>
```
Ⅳ. Tutorials
--------------------
## Ⅳ. Tutorials
---------------
- [zfoo sdk of csharp and lua for unity and godot](https://github.com/zfoo-project/zfoo-sdk-csharp-lua-unity-godot)
- [zfoo sdk typescript javascript cocos web h5](https://github.com/zfoo-project/zfoo-sdk-typescript-javascript-cocos-web-h5)
- [zfoo sdk gdscript for godot](https://github.com/zfoo-project/zfoo-sdk-gdscript-godot)
- [tank-game-server](https://github.com/zfoo-project/tank-game-server) Online game《The Fight of Tanks》,novice friendly,
difficulty 2 stars
- [godot-bird](https://github.com/zfoo-project/godot-bird) bird and birdpowered by godot
- [cocos-fivechess](https://github.com/zfoo-project/fivechess) five chessuse cocos as client
- [FAQ](./doc/FAQ.md)There are standard demo display and instructions in the test folder of each project directory,
which can be run directly
. Usage⭐
------------
## . Usage⭐
---------------
#### 1. [protocol](protocol/README.md) ultimate performance serialization and deserialization
@@ -114,7 +112,7 @@ NetContext.getCosumer()
HotSwapUtils.hotswapClass(bytes);
```
#### 4. [orm](orm/README.md) automatic mapping framework based on mongodbThe secondary cache is designed using [caffeine](https://github.com/ben-manes/caffeine) to fully release the database pressure
#### 4. [orm](orm/README.md) automatic mapping framework based on mongodb, The secondary cache is designed using [caffeine](https://github.com/ben-manes/caffeine) to fully release the database pressure
```
// You don't need to write sql and any configuration yourself, define a table in the database directly through annotation definitions
@@ -164,7 +162,7 @@ public class StudentResource {
}
```
Ⅵ. Commit specification👏
## Ⅵ. Commit specification👏
----------
- People who like this project are welcome to maintain this project together, and pay attention to the following
@@ -172,10 +170,9 @@ public class StudentResource {
- The code formats uses the default formatting of IntelliJ Idea
- [conventional-changelog-metahub](https://github.com/pvdlg/conventional-changelog-metahub#commit-types)
Ⅶ. License
## Ⅶ. License
-----------
zfoo use [Apache License Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
![JetBrains Logo (Main) logo](https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg)