This is an automated email from the ASF dual-hosted git repository.
liurenjie1024 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 8782665 docs: Refactor the README to be more user-oriented (#444)
8782665 is described below
commit 87826654800d6a071a249f91bc9993327f16690c
Author: Xuanwo <[email protected]>
AuthorDate: Mon Jul 8 15:58:31 2024 +0800
docs: Refactor the README to be more user-oriented (#444)
* docs: Refactor the README to be more user-oriented
Signed-off-by: Xuanwo <[email protected]>
* Apply suggestions from code review
Co-authored-by: Fokko Driesprong <[email protected]>
* Polish
Signed-off-by: Xuanwo <[email protected]>
---------
Signed-off-by: Xuanwo <[email protected]>
Co-authored-by: Fokko Driesprong <[email protected]>
---
README.md | 127 +++++++++++++++++++++++++-------------------------------------
1 file changed, 50 insertions(+), 77 deletions(-)
diff --git a/README.md b/README.md
index 47da862..3f4f7a3 100644
--- a/README.md
+++ b/README.md
@@ -17,89 +17,62 @@
~ under the License.
-->
-# Apache Iceberg Rust
-
-Native Rust implementation of [Apache Iceberg](https://iceberg.apache.org/).
-
-## Roadmap
-
-### Catalog
-
-| Catalog Type | Status |
-| ------------ | ----------- |
-| Rest | Done |
-| Hive | Done |
-| Sql | In Progress |
-| Glue | Done |
-| DynamoDB | Not Started |
-
-### FileIO
-
-| FileIO Type | Status |
-| ----------- | ----------- |
-| S3 | Done |
-| Local File | Done |
-| GCS | Not Started |
-| HDFS | Not Started |
-
-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
-
-#### Reader
-
-| Feature | Status |
-| ---------------------------------------------------------- | ----------- |
-| File based task planning | Done |
-| Size based task planning | Not started |
-| Filter pushdown(manifest evaluation, partition prunning) | In Progress |
-| Apply deletions, including equality and position deletions | Not started |
-| Read into arrow record batch | In Progress |
-| Parquet file support | Done |
-| ORC file support | Not started |
-
-#### Writer
-
-| Feature | Status |
-| ------------------------ | ----------- |
-| Data writer | Not started |
-| Equality deletion writer | Not started |
-| Position deletion writer | Not started |
-| Partitioned writer | Not started |
-| Upsert writer | Not started |
-| Parquet file support | Not started |
-| ORC file support | Not started |
-
-#### Transaction
-
-| Feature | Status |
-| --------------------- | ----------- |
-| Schema evolution | Not started |
-| Update partition spec | Not started |
-| Update properties | Not started |
-| Replace sort order | Not started |
-| Update location | Not started |
-| Append files | Not started |
-| Rewrite files | Not started |
-| Rewrite manifests | Not started |
-| Overwrite files | Not started |
-| Row level updates | Not started |
-| Replace partitions | Not started |
-| Snapshot management | Not started |
-
-### Integrations
-
-We will add integrations with other rust based data systems, such as polars,
datafusion, etc.
+# Apache Iceberg™ Rust
+
+
+
+Rust implementation of [Apache Iceberg™](https://iceberg.apache.org/).
+
+Working on [v0.3.0 Release
Milestone](https://github.com/apache/iceberg-rust/milestone/2)
+
+## Components
+
+The Apache Iceberg Rust project is composed of the following components:
+
+| Name | Release
| Docs |
+|------------------------|------------------------------------------------------------|------------------------------------------------------|
+| [iceberg] | [![iceberg image]][iceberg link]
| [![docs release]][iceberg release docs] |
+| [iceberg-datafusion] | -
| - |
+| [iceberg-catalog-glue] | -
| - |
+| [iceberg-catalog-hms] | [![iceberg-catalog-hms image]][iceberg-catalog-hms
link] | [![docs release]][iceberg-catalog-hms release docs] |
+| [iceberg-catalog-rest] | [![iceberg-catalog-rest
image]][iceberg-catalog-rest link] | [![docs release]][iceberg-catalog-rest
release docs] |
+
+[docs release]: https://img.shields.io/badge/docs-release-blue
+[iceberg]: crates/iceberg/README.md
+[iceberg image]: https://img.shields.io/crates/v/iceberg.svg
+[iceberg link]: https://crates.io/crates/iceberg
+[iceberg release docs]: https://docs.rs/iceberg
+
+[iceberg-datafusion]: crates/integrations/datafusion/README.md
+
+[iceberg-catalog-glue]: crates/catalog/glue/README.md
+
+[iceberg-catalog-hms]: crates/catalog/hms/README.md
+[iceberg-catalog-hms image]:
https://img.shields.io/crates/v/iceberg-catalog-hms.svg
+[iceberg-catalog-hms link]: https://crates.io/crates/iceberg-catalog-hms
+[iceberg-catalog-hms release docs]: https://docs.rs/iceberg-catalog-hms
+
+[iceberg-catalog-rest]: crates/catalog/rest/README.md
+[iceberg-catalog-rest image]:
https://img.shields.io/crates/v/iceberg-catalog-rest.svg
+[iceberg-catalog-rest link]: https://crates.io/crates/iceberg-catalog-rest
+[iceberg-catalog-rest release docs]: https://docs.rs/iceberg-catalog-rest
## Contribute
-Iceberg is an active open-source project. We are always open to people who
want to use it or contribute to it. Here are some ways to go.
+Apache Iceberg is an active open-source project, governed under the Apache
Software Foundation (ASF). We are always open to people who want to use or
contribute to it. Here are some ways to get involved.
- Start with [Contributing Guide](CONTRIBUTING.md).
- Submit [Issues](https://github.com/apache/iceberg-rust/issues/new) for bug
report or feature requests.
-- Discuss at [dev mailing list](mailto:[email protected])
([subscribe](<mailto:[email protected]?subject=(send%20this%20email%20to%20subscribe)>)
/
[unsubscribe](<mailto:[email protected]?subject=(send%20this%20email%20to%20unsubscribe)>)
/ [archives](https://lists.apache.org/[email protected]))
-- Talk to community directly at [Slack #rust
channel](https://join.slack.com/t/apache-iceberg/shared_invite/zt-1zbov3k6e-KtJfoaxp97YfX6dPz1Bk7A).
+- Discuss
+ at [dev mailing list](mailto:[email protected])
([subscribe](<mailto:[email protected]?subject=(send%20this%20email%20to%20subscribe)>)
/
[unsubscribe](<mailto:[email protected]?subject=(send%20this%20email%20to%20unsubscribe)>)
/ [archives](https://lists.apache.org/[email protected]))
+- Talk to the community directly
+ at [Slack #rust
channel](https://join.slack.com/t/apache-iceberg/shared_invite/zt-1zbov3k6e-KtJfoaxp97YfX6dPz1Bk7A).
+
+The Apache Iceberg community is built on the principles described in the
[Apache Way](https://www.apache.org/theapacheway/index.html) and all who engage
with the community are expected to be respectful, open, come with the best
interests of the community in mind, and abide by the Apache Foundation [Code of
Conduct](https://www.apache.org/foundation/policies/conduct.html).
+## Users
+
+- [Databend](https://github.com/datafuselabs/databend/): An open-source cloud
data warehouse that serves as a cost-effective alternative to Snowflake.
+- [iceberg-catalog](https://github.com/hansetag/iceberg-catalog): A Rust
implementation of the Iceberg REST Catalog specification.
## License
