You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iceberg.apache.org by fo...@apache.org on 2024/02/22 09:49:25 UTC
(iceberg-rust) branch main updated: docs: Add basic README for all crates (#215)
This is an automated email from the ASF dual-hosted git repository.
fokko pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iceberg-rust.git
The following commit(s) were added to refs/heads/main by this push:
new 86784ee docs: Add basic README for all crates (#215)
86784ee is described below
commit 86784ee2d191b61c7af8f9f05e7dd1f57c20e778
Author: Xuanwo <gi...@xuanwo.io>
AuthorDate: Thu Feb 22 17:49:20 2024 +0800
docs: Add basic README for all crates (#215)
* docs: Add basic README for all crates
Signed-off-by: Xuanwo <gi...@xuanwo.io>
* Remove license
Signed-off-by: Xuanwo <gi...@xuanwo.io>
* Update links
Signed-off-by: Xuanwo <gi...@xuanwo.io>
---------
Signed-off-by: Xuanwo <gi...@xuanwo.io>
---
README.md | 2 +-
crates/catalog/hms/README.md | 27 +++++++++++++++++++++++++++
crates/catalog/rest/README.md | 27 +++++++++++++++++++++++++++
crates/iceberg/README.md | 27 +++++++++++++++++++++++++++
4 files changed, 82 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 2e20714..1792c75 100644
--- a/README.md
+++ b/README.md
@@ -42,7 +42,7 @@ Native Rust implementation of [Apache Iceberg](https://iceberg.apache.org/).
| GCS | Not Started |
| HDFS | Not Started |
-Our `FileIO` is powered by [Apache OpenDAL](https://github.com/apache/incubator-opendal), so it would be quite easy to
+Our `FileIO` is powered by [Apache OpenDAL](https://github.com/apache/opendal), so it would be quite easy to
expand to other service.
### Table API
diff --git a/crates/catalog/hms/README.md b/crates/catalog/hms/README.md
new file mode 100644
index 0000000..bebb220
--- /dev/null
+++ b/crates/catalog/hms/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 Iceberg HiveMetaStore Catalog Official Native Rust Implementation
+
+[](https://crates.io/crates/iceberg-catalog-hms)
+[](https://docs.rs/iceberg/latest/iceberg-catalog-hms/)
+
+This crate contains the official Native Rust implementation of Apache Iceberg HiveMetaStore Catalog.
+
+See the [API documentation](https://docs.rs/iceberg-catalog-hms/latest) for examples and the full API.
diff --git a/crates/catalog/rest/README.md b/crates/catalog/rest/README.md
new file mode 100644
index 0000000..e3bb70e
--- /dev/null
+++ b/crates/catalog/rest/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 Iceberg Rest Catalog Official Native Rust Implementation
+
+[](https://crates.io/crates/iceberg-catalog-rest)
+[](https://docs.rs/iceberg/latest/iceberg-catalog-rest/)
+
+This crate contains the official Native Rust implementation of Apache Iceberg Rest Catalog.
+
+See the [API documentation](https://docs.rs/iceberg-catalog-rest/latest) for examples and the full API.
diff --git a/crates/iceberg/README.md b/crates/iceberg/README.md
new file mode 100644
index 0000000..513fa8a
--- /dev/null
+++ b/crates/iceberg/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 Iceberg Official Native Rust Implementation
+
+[](https://crates.io/crates/iceberg)
+[](https://docs.rs/iceberg/latest/iceberg/)
+
+This crate contains the official Native Rust implementation of [Apache Iceberg](https://rust.iceberg.apache.org/).
+
+See the [API documentation](https://docs.rs/iceberg/latest) for examples and the full API.