leekeiabstraction commented on code in PR #242: URL: https://github.com/apache/fluss-rust/pull/242#discussion_r2781413428
########## docs/rust-client.md: ########## @@ -0,0 +1,748 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +# Fluss Rust Client Guide + +This guide covers how to use the Fluss Rust client for reading and writing data to log tables and primary key tables. + +## Prerequisites + +- Rust 1.85+ +- Protobuf compiler (`protoc`) - only required when [building from source](#building-from-source) + +## Adding to Your Project + +The Fluss Rust client is published to [crates.io](https://crates.io/crates/fluss-rs) as `fluss-rs`. The crate's library name is `fluss`, so you import it with `use fluss::...`. + +```toml +[dependencies] +fluss-rs = "0.1" +tokio = { version = "1", features = ["full"] } +``` Review Comment: This was raised because I only updated the doc while on older main branch. Rebased. -- 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]
