Skip to content

Commit 85ef982

Browse files
authored
Update README (swoole#4346)
1 parent 4b9839d commit 85ef982

File tree

2 files changed

+32
-10
lines changed

2 files changed

+32
-10
lines changed

README-CN.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,36 @@
11
[English](./README.md) | 中文
22

3-
# Swoole
3+
<h1>
4+
<img width="200" height="120" align=center alt="Swoole Logo" src="https://www.swoole.co.uk/images/swoole-logo.svg" />
5+
</h1>
46

5-
[![Latest Version](https://img.shields.io/github/release/swoole/swoole-src.svg)](https://github.com/swoole/swoole-src/releases)
6-
[![License](https://img.shields.io/badge/license-apache2-blue.svg)](LICENSE)
77
[![lib-swoole](https://github.com/swoole/swoole-src/workflows/lib-swoole/badge.svg)](https://github.com/swoole/swoole-src/actions?query=workflow%3Alib-swoole)
88
[![ext-swoole](https://github.com/swoole/swoole-src/workflows/ext-swoole/badge.svg)](https://github.com/swoole/swoole-src/actions?query=workflow%3Aext-swoole)
99
[![test-linux](https://github.com/swoole/swoole-src/workflows/test-linux/badge.svg)](https://github.com/swoole/swoole-src/actions?query=workflow%3Atest-linux)
1010
[![Coverity Scan Build Status](https://scan.coverity.com/projects/11654/badge.svg)](https://scan.coverity.com/projects/swoole-swoole-src)
1111
[![codecov](https://codecov.io/gh/swoole/swoole-src/branch/master/graph/badge.svg)](https://codecov.io/gh/swoole/swoole-src)
1212

13-
![](./mascot.png)
14-
1513
**Swoole是一个C++编写的基于异步事件驱动和协程的并行网络通信引擎,为PHP提供高性能网络编程支持**
1614

17-
## ✨事件驱动
15+
## ⚙️ 快速启动
16+
17+
你可以直接使用 [Docker](https://github.com/swoole/docker-swoole) 来执行Swoole的代码,例如:
18+
19+
```bash
20+
docker run --rm phpswoole/swoole "php --ri swoole"
21+
```
22+
23+
具体的使用方式可以查看:[如何使用此镜像](https://github.com/swoole/docker-swoole#how-to-use-this-image)
24+
25+
或者你可以在Swoole官网提供的 [在线编程页面](https://www.swoole.com/coding) 运行你的代码以及官网提供的示例代码。
26+
27+
## ✨ 事件驱动
1828

19-
Swoole中的网络请求处理是基于事件的,并且充分利用了底层的epoll / kqueue实现,使得为数百万个请求提供服务变得非常容易。
29+
Swoole中的网络请求处理是基于事件的,并且充分利用了底层的 epoll/kqueue 实现,使得为数百万个请求提供服务变得非常容易。
2030

2131
Swoole4使用全新的协程内核引擎,现在它拥有一个全职的开发团队,因此我们正在进入PHP历史上前所未有的时期,为性能的高速提升提供了独一无二的可能性。
2232

23-
## ️协程
33+
## ️ 协程
2434

2535
Swoole4或更高版本拥有高可用性的内置协程,您可以使用完全同步的代码来实现异步性能,PHP代码没有任何额外的关键字,底层会自动进行协程调度。
2636

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,25 @@ English | [中文](./README-CN.md)
1212

1313
**Swoole is an event-driven asynchronous & coroutine-based concurrency networking communication engine with high performance written in C++ for PHP.**
1414

15-
## ✨Event-based
15+
## ⚙️ Quick Start
16+
17+
You can use [Docker](https://github.com/swoole/docker-swoole) directly to execute Swoole's code, e.g.
18+
19+
```bash
20+
docker run --rm phpswoole/swoole "php --ri swoole"
21+
```
22+
23+
For details on how to use it, see: [How to Use This Image](https://github.com/swoole/docker-swoole#how-to-use-this-image).
24+
25+
Or you can run your code and the sample code provided on the Swoole website at the [online coding page](https://www.swoole.com/coding).
26+
27+
## ✨ Event-based
1628

1729
The network layer in Swoole is event-based and takes full advantage of the underlying epoll/kqueue implementation, making it really easy to serve millions of requests.
1830

1931
Swoole 4.x uses a brand new engine kernel and now it has a full-time developer team, so we are entering an unprecedented period in PHP history which offers a unique possibility for rapid evolution in performance.
2032

21-
## ️Coroutine
33+
## Coroutine
2234

2335
Swoole 4.x or later supports the built-in coroutine with high availability, and you can use fully synchronized code to implement asynchronous performance. PHP code without any additional keywords, the underlying automatic coroutine-scheduling.
2436

0 commit comments

Comments
 (0)