Skip to content

Commit

Permalink
docs: add planned samples to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
whhe committed May 17, 2024
1 parent 4d61e00 commit 8ebcd21
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,32 @@

我们在 GitHub 上创建了一些任务,这些任务难度不高,对于首次贡献者来说比较友好,欢迎感兴趣的开发者认领:https://github.com/oceanbase/ob-samples/issues/16

如下是本仓库已经添加或计划在近期添加的示例:

- application
- TODO: `hertzbeat` `seatunnel`
- c
- TODO: `obconnector-c`
- c_plusplus
- TODO: `mysql-connector-cpp`
- c_sharp
- TODO: `mysql-connector-net` `MySqlConnector`
- golang
- `go-sql-driver`
- TODO: `gorm` `xorm` `obkv-table-client-go`
- java
- `mybatis-plus` `mysql-connector-java` `oceanbase-client` `testcontainers-java`
- TODO: `mybatis` `hibernate` `spring-jdbc` `spring-data-jpa` `hikaricp` `flink-cdc` `oblogclient` `obkv-table-client-java`
- javascript
- `sveltekit`
- php
- TODO: `mysqli` `pdo`
- python
- `mysql-connector-python` `pymysql`
- TODO: `mysqlclient` `sqlalchemy`
- rust
- TODO: `sqlx` `rust-mysql-simple` `obkv-table-client-rust`

### 增加一个示例

在本仓库中,一个示例将作为一个独立的模块存在,模块的目录名称应当与示例所用的工具保持一致,如 `mysql-connector-java` 的示例目录就命名为 `mysql-connector-java`
Expand Down
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,32 @@ We welcome contributions from anyone, thanks to all [contributors](https://githu

We have created some issues on GitHub for some samples which are simple and good for first time contributors: https://github.com/oceanbase/ob-samples/issues/16.

The following are samples that have been added or planned to be added in the near future:

- application
- TODO: `hertzbeat` `seatunnel`
- c
- TODO: `obconnector-c`
- c_plusplus
- TODO: `mysql-connector-cpp`
- c_sharp
- TODO: `mysql-connector-net` `MySqlConnector`
- golang
- `go-sql-driver`
- TODO: `gorm` `xorm` `obkv-table-client-go`
- java
- `mybatis-plus` `mysql-connector-java` `oceanbase-client` `testcontainers-java`
- TODO: `mybatis` `hibernate` `spring-jdbc` `spring-data-jpa` `hikaricp` `flink-cdc` `oblogclient` `obkv-table-client-java`
- javascript
- `sveltekit`
- php
- TODO: `mysqli` `pdo`
- python
- `mysql-connector-python` `pymysql`
- TODO: `mysqlclient` `sqlalchemy`
- rust
- TODO: `sqlx` `rust-mysql-simple` `obkv-table-client-rust`

### Add a sample

In this repository, every sample project will be as an independent module. The directory name of the module should be same with the tool used in the sample. For example, the sample of `mysql-connector-java` is named `mysql-connector-java`.
Expand Down

0 comments on commit 8ebcd21

Please sign in to comment.