Skip to content

Commit

Permalink
docs: add icon in readme (cloudwego#103)
Browse files Browse the repository at this point in the history
  • Loading branch information
kinggo authored Dec 31, 2021
1 parent 1344445 commit 6e61ab7
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 8 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
# CloudWeGo-Netpoll

[中文](README_CN.md)

# Introduction
[![Release](https://img.shields.io/github/v/release/cloudwego/netpoll)](https://github.com/cloudwego/netpoll/releases)
[![WebSite](https://img.shields.io/website?up_message=cloudwego&url=https%3A%2F%2Fwww.cloudwego.io%2F)](https://www.cloudwego.io/)
[![License](https://img.shields.io/github/license/cloudwego/netpoll)](https://github.com/cloudwego/netpoll/blob/main/LICENSE)
[![Go Report Card](https://goreportcard.com/badge/github.com/cloudwego/netpoll)](https://goreportcard.com/report/github.com/cloudwego/netpoll)
[![OpenIssue](https://img.shields.io/github/issues/cloudwego/netpoll)](https://github.com/cloudwego/netpoll/issues)
[![ClosedIssue](https://img.shields.io/github/issues-closed/cloudwego/netpoll)](https://github.com/cloudwego/netpoll/issues?q=is%3Aissue+is%3Aclosed)
![Stars](https://img.shields.io/github/stars/cloudwego/netpoll)
![Forks](https://img.shields.io/github/forks/cloudwego/netpoll)

## Introduction

[Netpoll][Netpoll] is a high-performance non-blocking I/O networking framework, which
focused on RPC scenarios, developed by [ByteDance][ByteDance].
Expand Down Expand Up @@ -31,7 +42,7 @@ using [Netpoll][Netpoll].

For more information, please refer to [Document](#document).

# Features
## Features

* **Already**
- [LinkBuffer][LinkBuffer] provides nocopy API for streaming reading and writing
Expand All @@ -54,7 +65,7 @@ For more information, please refer to [Document](#document).
* **Unsupported**
- Windows (operating system)

# Performance
## Performance

Benchmark should meet the requirements of industrial use.
In the RPC scenario, concurrency and timeout are necessary support items.
Expand All @@ -64,7 +75,7 @@ the performance of [Netpoll][Netpoll] and other frameworks under different condi

More benchmarks reference [kitex-benchmark][kitex-benchmark] and [hertz-benchmark][hertz-benchmark] (open source soon).

# Reference
## Reference

* [Official Website](https://www.cloudwego.io)
* [Getting Started](docs/guide/guide_en.md)
Expand Down
19 changes: 15 additions & 4 deletions README_CN.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
# CloudWeGo-Netpoll

[English](README.md)

# 简介
[![Release](https://img.shields.io/github/v/release/cloudwego/netpoll)](https://github.com/cloudwego/netpoll/releases)
[![WebSite](https://img.shields.io/website?up_message=cloudwego&url=https%3A%2F%2Fwww.cloudwego.io%2F)](https://www.cloudwego.io/)
[![License](https://img.shields.io/github/license/cloudwego/netpoll)](https://github.com/cloudwego/netpoll/blob/main/LICENSE)
[![Go Report Card](https://goreportcard.com/badge/github.com/cloudwego/netpoll)](https://goreportcard.com/report/github.com/cloudwego/netpoll)
[![OpenIssue](https://img.shields.io/github/issues/cloudwego/netpoll)](https://github.com/cloudwego/netpoll/issues)
[![ClosedIssue](https://img.shields.io/github/issues-closed/cloudwego/netpoll)](https://github.com/cloudwego/netpoll/issues?q=is%3Aissue+is%3Aclosed)
![Stars](https://img.shields.io/github/stars/cloudwego/netpoll)
![Forks](https://img.shields.io/github/forks/cloudwego/netpoll)

## 简介

[Netpoll][Netpoll] 是由 [字节跳动][ByteDance] 开发的高性能 NIO(Non-blocking I/O)
网络库,专注于 RPC 场景。
Expand All @@ -26,7 +37,7 @@ goroutine,大幅增加调度开销。此外,[net.Conn][net.Conn] 没有提

更多信息请参阅 [文档](#文档)

# 特性
## 特性

* **已经支持**
- [LinkBuffer][LinkBuffer] 提供可以流式读写的 nocopy API
Expand All @@ -49,15 +60,15 @@ goroutine,大幅增加调度开销。此外,[net.Conn][net.Conn] 没有提
* **不被支持**
- Windows(操作系统)

# 性能
## 性能

性能测试应满足工业级使用要求,在 RPC 场景下,并发请求、等待超时是必要的支持项。

我们提供了 [netpoll-benchmark][netpoll-benchmark] 项目用来长期追踪和比较 [Netpoll][Netpoll] 与其他框架在不同情况下的性能数据以供参考。

更多测试参考 [kitex-benchmark][kitex-benchmark][hertz-benchmark][hertz-benchmark] (即将开源)

# 参考
## 参考

* [官方网站](https://www.cloudwego.io)
* [使用文档](docs/guide/guide_cn.md)
Expand Down

0 comments on commit 6e61ab7

Please sign in to comment.