Skip to content

Commit

Permalink
hotfix: update outdated readme instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
whhe committed May 21, 2024
1 parent 3700e88 commit e1f8314
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 15 deletions.
10 changes: 2 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,14 @@ English | [简体中文](README_CN.md)

[![Build Status](https://github.com/oceanbase/oblogclient/actions/workflows/maven_build_master.yml/badge.svg?branch=master)](https://github.com/oceanbase/oblogclient/actions/workflows/maven_build_master.yml)
[![Release](https://img.shields.io/github/release/oceanbase/oblogclient.svg)](https://github.com/oceanbase/oblogclient/releases)
[![License](https://img.shields.io/badge/license-Mulan%20PSL%20v2-green.svg)](LICENSE)
[![License](https://img.shields.io/github/license/oceanbase/oblogclient)](LICENSE)

OceanBase Log Client is a library for obtaining the commit log of [OceanBase](https://github.com/oceanbase/oceanbase).

Getting Started
---------------

### Work with LogProxy

You can use this project with [oblogproxy](https://github.com/oceanbase/oblogproxy) to get the commit log of OceanBase. See the [LogProxy client tutorial](docs/quickstart/logproxy-client-tutorial.md) for more details.

### Connect to OceanBase Directly

Coming soon.
You can use this library with [oblogproxy](https://github.com/oceanbase/oblogproxy) to get the commit log of OceanBase. See the [LogProxy client tutorial](docs/quickstart/logproxy-client-tutorial.md) for more details.

Communication
---------------
Expand Down
8 changes: 1 addition & 7 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,15 @@ OceanBase 日志客户端

[![Build Status](https://github.com/oceanbase/oblogclient/actions/workflows/maven_build_master.yml/badge.svg?branch=master)](https://github.com/oceanbase/oblogclient/actions/workflows/maven_build_master.yml)
[![Release](https://img.shields.io/github/release/oceanbase/oblogclient.svg)](https://github.com/oceanbase/oblogclient/releases)
[![License](https://img.shields.io/badge/license-Mulan%20PSL%20v2-green.svg)](LICENSE)
[![License](https://img.shields.io/github/license/oceanbase/oblogclient)](LICENSE)

OceanBase 日志客户端是一个可用于获取 [OceanBase](https://github.com/oceanbase/oceanbase) 增量数据变动 clog (commit log)的 Java 依赖库。

开始上手
---------------

### 搭配 LogProxy 使用

你可以搭配 [oblogproxy](https://github.com/oceanbase/oblogproxy) 来获取 OceanBase 的 clog。更多信息可以查看 [LogProxy 客户端使用教程](docs/quickstart/logproxy-client-tutorial-cn.md)

### 直连 OceanBase 数据库

规划中,敬请期待。

沟通交流
---------------
* [GitHub Issues](https://github.com/oceanbase/oblogclient/issues) (报 bug 或请求新的功能)
Expand Down

0 comments on commit e1f8314

Please sign in to comment.