diff --git a/README.md b/README.md index 5934bf1b9..d68ed1e52 100644 --- a/README.md +++ b/README.md @@ -38,15 +38,16 @@ English | [中文](README_ZH.md) - [x] Efficient, reusable, and elastic memory buffer: (Elastic-)Ring-Buffer, Linked-List-Buffer and Elastic-Mixed-Buffer - [x] Multiple protocols/IPC mechanisms: `TCP`, `UDP`, and `Unix Domain Socket` - [x] Multiple load-balancing algorithms: `Round-Robin`, `Source-Addr-Hash`, and `Least-Connections` -- [x] Two event-driven mechanisms: `epoll` on **Linux** and `kqueue` on **FreeBSD/DragonFly/Darwin** - [x] Flexible ticker event -- [x] Implementation of `gnet` Client -- [x] **Windows** platform support (For compatibility in development only, do not use it in production) +- [x] `gnet` client +- [x] Running on `Linux`, `macOS`, `Windows`, and *BSD: `Darwin`/`DragonFlyBSD`/`FreeBSD`/`NetBSD`/`OpenBSD` - [x] **Edge-triggered** I/O support - [x] Multiple network addresses binding - [ ] **TLS** support - [ ] [io_uring](https://kernel.dk/io_uring.pdf) support +***Windows version of `gnet` should only be used in development for developing and testing, it shouldn't be used in production.*** + # 🎬 Getting started `gnet` is available as a Go module and we highly recommend that you use `gnet` via [Go Modules](https://go.dev/blog/using-go-modules), with Go 1.11 Modules enabled (Go 1.11+), you can just simply add `import "github.com/panjf2000/gnet/v2"` to the codebase and run `go mod download/go mod tidy` or `go [build|run|test]` to download the necessary dependencies automatically. diff --git a/README_ZH.md b/README_ZH.md index 43db28d00..70f1c2c4d 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -38,15 +38,16 @@ - [x] 高效、可重用而且自动伸缩的内存 buffer:(Elastic-)Ring-Buffer, Linked-List-Buffer and Elastic-Mixed-Buffer - [x] 多种网络协议/IPC 机制:`TCP`、`UDP` 和 `Unix Domain Socket` - [x] 多种负载均衡算法:`Round-Robin(轮询)`、`Source-Addr-Hash(源地址哈希)` 和 `Least-Connections(最少连接数)` -- [x] 两种事件驱动机制:**Linux** 里的 `epoll` 以及 **FreeBSD/DragonFly/Darwin** 里的 `kqueue` - [x] 灵活的事件定时器 -- [x] 实现 `gnet` 客户端 -- [x] 支持 **Windows** 平台 (仅用于开发环境的兼容性,不要在生产环境中使用) +- [x] `gnet` 客户端支持 +- [x] 支持 `Linux`, `macOS`, `Windows` 和 *BSD 操作系统: `Darwin`/`DragonFlyBSD`/`FreeBSD`/`NetBSD`/`OpenBSD` - [x] **Edge-triggered** I/O 支持 - [x] 多网络地址绑定 - [ ] **TLS** 支持 - [ ] [io_uring](https://kernel.dk/io_uring.pdf) 支持 +***`gnet` 的 Windows 版本应该仅用于开发阶段的开发和测试,切勿用于生产环境***。 + # 🎬 开始 `gnet` 是一个 Go module,而且我们也强烈推荐通过 [Go Modules](https://go.dev/blog/using-go-modules) 来使用 `gnet`,在开启 Go Modules 支持(Go 1.11+)之后可以通过简单地在代码中写 `import "github.com/panjf2000/gnet/v2"` 来引入 `gnet`,然后执行 `go mod download/go mod tidy` 或者 `go [build|run|test]` 这些命令来自动下载所依赖的包。