tiennm99/zfoo
1
0 Fork 0
mirror of https://github.com/tiennm99/zfoo.git synced 2026-10-15 16:15:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #95 from guanjie-tom-wang/fix-Readme-Typo

Browse Source 
Fix Readme.md Typos
This commit is contained in:
godotg authored and GitHub committed 2024-03-23 18:01:25 +08:00
2 parents 92b8ee0680 260d60bf14
commit df54c2ce97
1 file changed
+24 -34
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+24 -34
View File
@@ -1,37 +1,35 @@
English | [简体中文](./README_CN.md) English | [简体中文](./README_CN.md)
<a href="https://github.com/zfoo-project/zfoo"><img src="/doc/image/logo.jpg" width="30%"></a> <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** - **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 - **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 - **High scalability**, Single server deployment, microservice deployment, cluster deployment, gateway deployment
- **Can be used as a game server framework or website server framework.** - **Can be used as a game server framework or website server framework.**
Perfect work development process, complete online solution 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) 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) configuration** [storage](storage/src/test/java/com/zfoo/storage/ApplicationTest.java)
- Automapping framework for MongoDB [orm](orm/README.md) - Automapping framework for MongoDB [orm](orm/README.md)
- Event bus [event](event/src/test/java/com/zfoo/event/ApplicationTest.java) - Event bus [event](event/src/test/java/com/zfoo/event/ApplicationTest.java)
- Time task scheduling [scheduler](scheduler/README.md) - 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) required [monitor](monitor/src/test/java/com/zfoo/monitor/ApplicationTest.java)
Ⅱ. Who use this project ## Ⅱ. Who uses 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 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 - Projects such as saving, development, deployment, operation and maintenance costs
- As a backend infrastructure for **Godot，Unity，Cocos，Webgl，H5**，Network protocol supports tcp udp websocket http - As a backend infrastructure for **Godot, Unity, Cocos，Webgl, H5**, Network protocol supports tcp udp websocket http
- [Keep it Simple and Stupid](https://baike.baidu.com/item/KISS原则/3242383) ，simple configuration, lightweight code - [Keep it Simple and Stupid](https://baike.baidu.com/item/KISS原则/3242383), simple configuration, lightweight code
## Ⅲ. Maven dependency✨
Ⅲ. Maven dependency✨
------------
- Environment requirement **JDK 17+**, support **OpenJDK**, **Oracle JDK** and **native GraalVM** - Environment requirement **JDK 17+**, support **OpenJDK**, **Oracle JDK** and **native GraalVM**
@@ -43,7 +41,7 @@ Perfect work development process, complete online solution
</dependency> </dependency>
``` ```
- If you don't want to depend all zfoo modules, you only need to choose to depend on one of them - If you don't want to depend on all zfoo modules, you only need to choose to depend on one of them
``` ```
<dependency> <dependency>
@@ -53,26 +51,21 @@ Perfect work development process, complete online solution
</dependency> </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 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 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) - [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,
- [tank-game-server](https://github.com/zfoo-project/tank-game-server) Online game《The Fight of Tanks》，novice friendly,
difficulty 2 stars difficulty 2 stars
- [godot-bird](https://github.com/zfoo-project/godot-bird) bird and bird，powered by godot - [godot-bird](https://github.com/zfoo-project/godot-bird) bird and bird，powered by godot
- [cocos-fivechess](https://github.com/zfoo-project/fivechess) five chess，use cocos as client - [cocos-fivechess](https://github.com/zfoo-project/fivechess) five chess，use cocos as client
- [FAQ](./doc/FAQ.md)，There are standard demo display and instructions in the test folder of each project directory, - [FAQ](./doc/FAQ.md)，There are standard demo display and instructions in the test folder of each project directory,
which can be run directly which can be run directly
Ⅴ. Usage⭐ ## Ⅴ. Usage⭐
------------
#### 1. [protocol](protocol/README.md) ultimate performance serialization and deserialization #### 1. [protocol](protocol/README.md) ultimate performance serialization and deserialization
@@ -114,7 +107,7 @@ NetContext.getCosumer()
HotSwapUtils.hotswapClass(bytes); HotSwapUtils.hotswapClass(bytes);
``` ```
#### 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 #### 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 // You don't need to write sql and any configuration yourself, define a table in the database directly through annotation definitions
@@ -164,18 +157,15 @@ 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 - People who like this project are welcome to maintain this project together, and pay attention to the following
specifications when submitting code specifications when submitting code
- The code formats uses the default formatting of IntelliJ Idea - The code formats use the default formatting of IntelliJ Idea
- [conventional-changelog-metahub](https://github.com/pvdlg/conventional-changelog-metahub#commit-types) - [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) 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) ![JetBrains Logo (Main) logo](https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg)