This is an automated email from the ASF dual-hosted git repository.
xushiyan pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/hudi-rs.git
The following commit(s) were added to refs/heads/main by this push:
new 2c59bf1 docs: update readme logo and example (#65)
2c59bf1 is described below
commit 2c59bf100c5e77df002edecb2bef8defaa5f209e
Author: Shiyan Xu <[email protected]>
AuthorDate: Fri Jul 12 18:56:33 2024 -0500
docs: update readme logo and example (#65)
---
README.md | 20 +++++++++++++-------
1 file changed, 13 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index 9658bfd..d59947d 100644
--- a/README.md
+++ b/README.md
@@ -19,7 +19,7 @@
<p align="center">
<a href="https://hudi.apache.org/">
- <img src="https://hudi.apache.org/assets/images/hudi-logo-medium.png"
alt="Hudi logo" height="80px">
+ <img
src="https://hudi.apache.org/assets/images/hudi_logo_transparent_1400x600.png"
alt="Hudi logo" height="120px">
</a>
</p>
<p align="center">
@@ -53,6 +53,10 @@ users and projects.
## Example usage
+> [!NOTE]
+> These examples expect a Hudi table exists at `/tmp/trips_table`, created
using
+> the [quick start guide](https://hudi.apache.org/docs/quick-start-guide).
+
### Python
Read a Hudi table into a PyArrow table.
@@ -76,14 +80,16 @@ print(result)
### Rust
<details>
-<summary>Add crate `hudi` with `datafusion` feature to your application to
query a Hudi table.</summary>
+<summary>Add crate hudi with datafusion feature to your application to query a
Hudi table.</summary>
-```yaml
-[dependencies]
-hudi = { version = "0" , features = ["datafusion"] }
-tokio = "1"
-datafusion = "39.0.0"
+```shell
+cargo new my_project --bin && cd my_project
+cargo add tokio@1 datafusion@39
+cargo add hudi --features datafusion
```
+
+Update `src/main.rs` with the code snippet below then `cargo run`.
+
</details>
```rust