Skip to content

Commit e0b5e5c

Browse files
authored
doc: add readme for paimon & datafusion integration crate (#209)
1 parent 5d1a930 commit e0b5e5c

4 files changed

Lines changed: 58 additions & 2 deletions

File tree

crates/integrations/datafusion/Cargo.toml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ name = "paimon-datafusion"
2020
edition.workspace = true
2121
version.workspace = true
2222
license.workspace = true
23-
description = "Apache Paimon DataFusion Integration (read-only)"
23+
homepage = "https://paimon.apache.org/docs/rust/datafusion/"
24+
documentation = "https://docs.rs/paimon-datafusion"
25+
description = "Apache Paimon DataFusion Integration"
2426
categories = ["database"]
2527
keywords = ["paimon", "datafusion", "integrations"]
2628

@@ -32,5 +34,4 @@ paimon = { path = "../../paimon" }
3234
futures = "0.3"
3335

3436
[dev-dependencies]
35-
serde_json = "1"
3637
tokio = { version = "1", features = ["macros", "rt-multi-thread"] }
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<!--
2+
~ Licensed to the Apache Software Foundation (ASF) under one
3+
~ or more contributor license agreements. See the NOTICE file
4+
~ distributed with this work for additional information
5+
~ regarding copyright ownership. The ASF licenses this file
6+
~ to you under the Apache License, Version 2.0 (the
7+
~ "License"); you may not use this file except in compliance
8+
~ with the License. You may obtain a copy of the License at
9+
~
10+
~ http://www.apache.org/licenses/LICENSE-2.0
11+
~
12+
~ Unless required by applicable law or agreed to in writing,
13+
~ software distributed under the License is distributed on an
14+
~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
~ KIND, either express or implied. See the License for the
16+
~ specific language governing permissions and limitations
17+
~ under the License.
18+
-->
19+
20+
# Apache Paimon DataFusion Integration
21+
22+
[![crates.io](https://img.shields.io/crates/v/paimon-datafusion.svg)](https://crates.io/crates/paimon-datafusion)
23+
[![docs.rs](https://img.shields.io/docsrs/paimon-datafusion.svg)](https://docs.rs/paimon-datafusion/latest/paimon_datafusion/)
24+
25+
This crate contains the integration of [Apache DataFusion](https://datafusion.apache.org/) and [Apache Paimon](https://paimon.apache.org/).
26+
27+
See the [documentation](https://paimon.apache.org/docs/rust/datafusion/) for getting started guide and more details.

crates/paimon/Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ description = "The rust implementation of Apache Paimon"
2121
documentation = "https://docs.rs/paimon"
2222
name = "paimon"
2323

24+
homepage.workspace = true
2425
repository.workspace = true
2526
edition.workspace = true
2627
license.workspace = true

crates/paimon/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<!--
2+
~ Licensed to the Apache Software Foundation (ASF) under one
3+
~ or more contributor license agreements. See the NOTICE file
4+
~ distributed with this work for additional information
5+
~ regarding copyright ownership. The ASF licenses this file
6+
~ to you under the Apache License, Version 2.0 (the
7+
~ "License"); you may not use this file except in compliance
8+
~ with the License. You may obtain a copy of the License at
9+
~
10+
~ http://www.apache.org/licenses/LICENSE-2.0
11+
~
12+
~ Unless required by applicable law or agreed to in writing,
13+
~ software distributed under the License is distributed on an
14+
~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
~ KIND, either express or implied. See the License for the
16+
~ specific language governing permissions and limitations
17+
~ under the License.
18+
-->
19+
20+
# Apache Paimon Rust
21+
22+
[![crates.io](https://img.shields.io/crates/v/paimon.svg)](https://crates.io/crates/paimon)
23+
[![docs.rs](https://img.shields.io/docsrs/paimon.svg)](https://docs.rs/paimon/latest/paimon/)
24+
25+
This crate contains the official Native Rust implementation of [Apache Paimon](https://paimon.apache.org/).
26+
27+
See the [documentation](https://paimon.apache.org/docs/rust/) for getting started guide and more details.

0 commit comments

Comments
 (0)