leekeiabstraction commented on code in PR #415: URL: https://github.com/apache/fluss-rust/pull/415#discussion_r2880846422
########## crates/fluss/README.md: ########## @@ -1,25 +1,105 @@ -# Apache Fluss™ Rust Client (Incubating) +# Apache Fluss (Incubating) Official Rust Client -Rust client library for [Apache Fluss™](https://fluss.apache.org/). This crate provides the core client used by the fluss-rust workspace and by the Python and C++ bindings. +Official Rust client library for [Apache Fluss (Incubating)](https://fluss.apache.org/). -# Todo: move how to use to the first, and how to build to the last, https://github.com/apache/opendal/blob/main/core/README.md -# is a good reference +[](https://crates.io/crates/fluss-rs) +[](https://docs.rs/fluss-rs/) -## Requirements +## Usage -- Rust (see [rust-toolchain.toml](../../rust-toolchain.toml) at repo root) -- protobuf (for build) +The following example shows both **primary key (KV) tables** and **log tables** in one flow: connect, create a KV table (upsert + lookup), then create a log table (append + scan). -## Build +```rust Review Comment: @charlesdong1991 This crossed my mind as well (I partially mitigate for python package docs by using generating it from other existing website documentations). Generally there are duplications in test cases, examples, documentations and package readmes. It sounds like there's an opportunity to improve this e.g., test cases as ground truth, scripts then populate docs code snippets from test cases. This way, there's less effort in separately maintaining doc as well as ensuring that documents are accurate. The work it saves increases as we have more language bindings. The script can even highlight gaps in testing /feature. But this might be something that we consider in the mid/longer term. It's certainly worth coming up with a proposal for it (there might be some other OS project which already solves this.) Happy to collaborate on proposing something. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
