This is an automated email from the ASF dual-hosted git repository.
wasphin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/brpc.git
The following commit(s) were added to refs/heads/master by this push:
new f162a6f3b Fix inconsistent punctuation in READMEs (#3699)
f162a6f3b is described below
commit f162a6f3ba7668dc876c5267a3b0b6b104bb0974
Author: Li Gewei <[email protected]>
AuthorDate: Sun Nov 1 23:44:24 2026 +0800
Fix inconsistent punctuation in READMEs (#3699)
Co-authored-by: ligewei <[email protected]>
---
README.md | 16 ++++++++--------
README_cn.md | 28 ++++++++++++++--------------
2 files changed, 22 insertions(+), 22 deletions(-)
diff --git a/README.md b/README.md
index d65366faf..199195013 100644
--- a/README.md
+++ b/README.md
@@ -11,20 +11,20 @@
### "bRPC" means "better RPC".
You can use it to:
-* Build a server that can talk in multiple protocols (**on same port**), or
access all sorts of services
+* Build a server that can talk in multiple protocols (**on same port**), or
access all sorts of services:
* restful http/https,
[h2](https://httpwg.org/specs/rfc9113.html)/[gRPC](https://grpc.io). using
http/h2 in bRPC is much more friendly than
[libcurl](https://curl.haxx.se/libcurl/). Access protobuf-based protocols with
HTTP/h2+json, probably from another language.
* [redis](docs/en/redis_client.md) and
[memcached](docs/en/memcache_client.md), thread-safe, more friendly and
performant than the official clients.
*
[rtmp](https://github.com/apache/brpc/blob/master/src/brpc/rtmp.h)/[flv](https://en.wikipedia.org/wiki/Flash_Video)/[hls](https://en.wikipedia.org/wiki/HTTP_Live_Streaming),
for building [streaming services](https://github.com/brpc/media-server).
- * hadoop_rpc (may be opensourced)
- * [rdma](https://en.wikipedia.org/wiki/Remote_direct_memory_access) support
+ * hadoop_rpc (may be opensourced).
+ * [rdma](https://en.wikipedia.org/wiki/Remote_direct_memory_access) support.
* [thrift](docs/en/thrift.md) support, thread-safe, more friendly and
performant than the official clients.
* all sorts of protocols used in Baidu: [baidu_std](docs/en/baidu_std.md),
[streaming_rpc](docs/en/streaming_rpc.md), hulu_pbrpc,
[sofa_pbrpc](https://github.com/baidu/sofa-pbrpc), nova_pbrpc, public_pbrpc,
ubrpc and nshead-based ones.
- * Build [HA](https://en.wikipedia.org/wiki/High_availability) distributed
services using an industrial-grade implementation of [RAFT consensus
algorithm](https://raft.github.io) which is opensourced at
[braft](https://github.com/brpc/braft)
+ * Build [HA](https://en.wikipedia.org/wiki/High_availability) distributed
services using an industrial-grade implementation of [RAFT consensus
algorithm](https://raft.github.io) which is opensourced at
[braft](https://github.com/brpc/braft).
* Servers can handle requests [synchronously](docs/en/server.md) or
[asynchronously](docs/en/server.md#asynchronous-service).
* Clients can access servers
[synchronously](docs/en/client.md#synchronus-call),
[asynchronously](docs/en/client.md#asynchronous-call),
[semi-synchronously](docs/en/client.md#semi-synchronous-call), or use [combo
channels](docs/en/combo_channel.md) to simplify sharded or parallel accesses
declaratively.
* Debug services [via http](docs/en/builtin_service.md), and run
[cpu](docs/en/cpu_profiler.md), [heap](docs/en/heap_profiler.md) and
[contention](docs/en/contention_profiler.md) profilers.
* Get [better latency and
throughput](docs/en/overview.md#better-latency-and-throughput).
-* [Extend bRPC](docs/en/new_protocol.md) with the protocols used in your
organization quickly, or customize components, including [naming
services](docs/en/load_balancing.md) (dns, zk, etcd), [load
balancers](docs/en/load_balancing.md) (rr, random, consistent hashing)
+* [Extend bRPC](docs/en/new_protocol.md) with the protocols used in your
organization quickly, or customize components, including [naming
services](docs/en/load_balancing.md) (dns, zk, etcd), [load
balancers](docs/en/load_balancing.md) (rr, random, consistent hashing).
# Try it!
@@ -111,8 +111,8 @@ You can use it to:
Please refer to [here](CONTRIBUTING.md).
# Feedback and Getting involved
-* Report bugs, ask questions or give suggestions by [Github
Issues](https://github.com/apache/brpc/issues)
-* Subscribe to the mailing list([email protected]) to get updated
with the project
+* Report bugs, ask questions or give suggestions by [Github
Issues](https://github.com/apache/brpc/issues).
+* Subscribe to the mailing list([email protected]) to get updated
with the project.
# Code of Conduct
-We follow the code of conduct from Apache Software Foundation, please refer it
here [Link](https://www.apache.org/foundation/policies/conduct)
+We follow the code of conduct from Apache Software Foundation, please refer it
here [Link](https://www.apache.org/foundation/policies/conduct).
diff --git a/README_cn.md b/README_cn.md
index 2cc686bd8..d02ad2c49 100644
--- a/README_cn.md
+++ b/README_cn.md
@@ -12,25 +12,25 @@
你可以使用它:
-* 搭建能在**一个端口**支持多协议的服务, 或访问各种服务
- * restful http/https,
[h2](https://httpwg.org/specs/rfc9113.html)/[gRPC](https://grpc.io)。使用bRPC的http实现比[libcurl](https://curl.haxx.se/libcurl/)方便多了。从其他语言通过HTTP/h2+json访问基于protobuf的协议.
+* 搭建能在**一个端口**支持多协议的服务, 或访问各种服务:
+ * restful http/https,
[h2](https://httpwg.org/specs/rfc9113.html)/[gRPC](https://grpc.io)。使用bRPC的http实现比[libcurl](https://curl.haxx.se/libcurl/)方便多了。从其他语言通过HTTP/h2+json访问基于protobuf的协议。
* [redis](docs/cn/redis_client.md)和[memcached](docs/cn/memcache_client.md),
线程安全,比官方client更方便。
- *
[rtmp](https://github.com/apache/brpc/blob/master/src/brpc/rtmp.h)/[flv](https://en.wikipedia.org/wiki/Flash_Video)/[hls](https://en.wikipedia.org/wiki/HTTP_Live_Streaming),
可用于搭建[流媒体服务](https://github.com/brpc/media-server).
- * hadoop_rpc(可能开源)
- * 支持[rdma](https://en.wikipedia.org/wiki/Remote_direct_memory_access)
- * 支持[thrift](docs/cn/thrift.md) , 线程安全,比官方client更方便
- * 各种百度内使用的协议: [baidu_std](docs/cn/baidu_std.md),
[streaming_rpc](docs/cn/streaming_rpc.md), hulu_pbrpc,
[sofa_pbrpc](https://github.com/baidu/sofa-pbrpc), nova_pbrpc, public_pbrpc,
ubrpc和使用nshead的各种协议.
+ *
[rtmp](https://github.com/apache/brpc/blob/master/src/brpc/rtmp.h)/[flv](https://en.wikipedia.org/wiki/Flash_Video)/[hls](https://en.wikipedia.org/wiki/HTTP_Live_Streaming),
可用于搭建[流媒体服务](https://github.com/brpc/media-server)。
+ * hadoop_rpc(可能开源)。
+ * 支持[rdma](https://en.wikipedia.org/wiki/Remote_direct_memory_access)。
+ * 支持[thrift](docs/cn/thrift.md) , 线程安全,比官方client更方便。
+ * 各种百度内使用的协议: [baidu_std](docs/cn/baidu_std.md),
[streaming_rpc](docs/cn/streaming_rpc.md), hulu_pbrpc,
[sofa_pbrpc](https://github.com/baidu/sofa-pbrpc), nova_pbrpc, public_pbrpc,
ubrpc和使用nshead的各种协议。
*
基于工业级的[RAFT算法](https://raft.github.io)实现搭建[高可用](https://en.wikipedia.org/wiki/High_availability)分布式系统,已在[braft](https://github.com/brpc/braft)开源。
* Server能[同步](docs/cn/server.md)或[异步](docs/cn/server.md#异步service)处理请求。
*
Client支持[同步](docs/cn/client.md#同步访问)、[异步](docs/cn/client.md#异步访问)、[半同步](docs/cn/client.md#半同步),或使用[组合channels](docs/cn/combo_channel.md)简化复杂的分库或并发访问。
-* [通过http界面](docs/cn/builtin_service.md)调试服务,
使用[cpu](docs/cn/cpu_profiler.md), [heap](docs/cn/heap_profiler.md),
[contention](docs/cn/contention_profiler.md) profilers.
-* 获得[更好的延时和吞吐](docs/cn/overview.md#更好的延时和吞吐).
-* 把你组织中使用的协议快速地[加入bRPC](docs/cn/new_protocol.md),或定制各类组件,
包括[命名服务](docs/cn/load_balancing.md#命名服务) (dns, zk, etcd),
[负载均衡](docs/cn/load_balancing.md#负载均衡) (rr, random, consistent hashing)
+* [通过http界面](docs/cn/builtin_service.md)调试服务,
使用[cpu](docs/cn/cpu_profiler.md), [heap](docs/cn/heap_profiler.md),
[contention](docs/cn/contention_profiler.md) profilers。
+* 获得[更好的延时和吞吐](docs/cn/overview.md#更好的延时和吞吐)。
+* 把你组织中使用的协议快速地[加入bRPC](docs/cn/new_protocol.md),或定制各类组件,
包括[命名服务](docs/cn/load_balancing.md#命名服务) (dns, zk, etcd),
[负载均衡](docs/cn/load_balancing.md#负载均衡) (rr, random, consistent hashing)。
# 试一下!
* 通过[概述](docs/cn/overview.md)了解哪里可以用bRPC及其优势。
-* 阅读[编译步骤](docs/cn/getting_started.md)了解如何开始使用,
之后可以运行一下[示例程序](https://github.com/apache/brpc/tree/master/example/).
+* 阅读[编译步骤](docs/cn/getting_started.md)了解如何开始使用,
之后可以运行一下[示例程序](https://github.com/apache/brpc/tree/master/example/)。
* 文档:
* [性能测试](docs/cn/benchmark.md)
* [bvar](docs/cn/bvar.md)
@@ -117,9 +117,9 @@
# 反馈和参与
-* bug、疑惑、修改建议都欢迎提在[Github Issues](https://github.com/apache/brpc/issues)中
-* 订阅邮件列表([email protected])获得项目最新信息
+* bug、疑惑、修改建议都欢迎提在[Github Issues](https://github.com/apache/brpc/issues)中。
+* 订阅邮件列表([email protected])获得项目最新信息。
# 行为准则
-我们遵守Apache软件基金会的行为准则, 请参考如下
[链接](https://www.apache.org/foundation/policies/conduct)
+我们遵守Apache软件基金会的行为准则, 请参考如下
[链接](https://www.apache.org/foundation/policies/conduct)。
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]