This is an automated email from the ASF dual-hosted git repository.
lzljs3620320 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/paimon-rust.git
The following commit(s) were added to refs/heads/main by this push:
new e0b5e5c doc: add readme for paimon & datafusion integration crate
(#209)
e0b5e5c is described below
commit e0b5e5cb5b89c5122f2b7550301fea44273d5b99
Author: yuxia Luo <[email protected]>
AuthorDate: Mon Apr 6 08:37:33 2026 +0800
doc: add readme for paimon & datafusion integration crate (#209)
---
crates/integrations/datafusion/Cargo.toml | 5 +++--
crates/integrations/datafusion/README.md | 27 +++++++++++++++++++++++++++
crates/paimon/Cargo.toml | 1 +
crates/paimon/README.md | 27 +++++++++++++++++++++++++++
4 files changed, 58 insertions(+), 2 deletions(-)
diff --git a/crates/integrations/datafusion/Cargo.toml
b/crates/integrations/datafusion/Cargo.toml
index e6ac2d3..6dbd34f 100644
--- a/crates/integrations/datafusion/Cargo.toml
+++ b/crates/integrations/datafusion/Cargo.toml
@@ -20,7 +20,9 @@ name = "paimon-datafusion"
edition.workspace = true
version.workspace = true
license.workspace = true
-description = "Apache Paimon DataFusion Integration (read-only)"
+homepage = "https://paimon.apache.org/docs/rust/datafusion/";
+documentation = "https://docs.rs/paimon-datafusion";
+description = "Apache Paimon DataFusion Integration"
categories = ["database"]
keywords = ["paimon", "datafusion", "integrations"]
@@ -32,5 +34,4 @@ paimon = { path = "../../paimon" }
futures = "0.3"
[dev-dependencies]
-serde_json = "1"
tokio = { version = "1", features = ["macros", "rt-multi-thread"] }
diff --git a/crates/integrations/datafusion/README.md
b/crates/integrations/datafusion/README.md
new file mode 100644
index 0000000..92f8a29
--- /dev/null
+++ b/crates/integrations/datafusion/README.md
@@ -0,0 +1,27 @@
+<!--
+ ~ 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.
+-->
+
+# Apache Paimon DataFusion Integration
+
+[](https://crates.io/crates/paimon-datafusion)
+[](https://docs.rs/paimon-datafusion/latest/paimon_datafusion/)
+
+This crate contains the integration of [Apache
DataFusion](https://datafusion.apache.org/) and [Apache
Paimon](https://paimon.apache.org/).
+
+See the [documentation](https://paimon.apache.org/docs/rust/datafusion/) for
getting started guide and more details.
diff --git a/crates/paimon/Cargo.toml b/crates/paimon/Cargo.toml
index 6c6dee8..a4a4ae4 100644
--- a/crates/paimon/Cargo.toml
+++ b/crates/paimon/Cargo.toml
@@ -21,6 +21,7 @@ description = "The rust implementation of Apache Paimon"
documentation = "https://docs.rs/paimon";
name = "paimon"
+homepage.workspace = true
repository.workspace = true
edition.workspace = true
license.workspace = true
diff --git a/crates/paimon/README.md b/crates/paimon/README.md
new file mode 100644
index 0000000..5cbdce0
--- /dev/null
+++ b/crates/paimon/README.md
@@ -0,0 +1,27 @@
+<!--
+ ~ 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.
+-->
+
+# Apache Paimon Rust
+
+[](https://crates.io/crates/paimon)
+[](https://docs.rs/paimon/latest/paimon/)
+
+This crate contains the official Native Rust implementation of [Apache
Paimon](https://paimon.apache.org/).
+
+See the [documentation](https://paimon.apache.org/docs/rust/) for getting
started guide and more details.
