diff --git a/bin/oay/README.md b/bin/oay/README.md index eae03f47a8c2..044bd5d679b7 100644 --- a/bin/oay/README.md +++ b/bin/oay/README.md @@ -1,6 +1,14 @@ -# Oay +# Apache OpenDAL™ Oay -Oay is an OpenDAL Gateway that empowers users to access data through their preferred APIs. +[build status]: https://img.shields.io/github/actions/workflow/status/apache/opendal/ci_bin_oay.yml?branch=main +[actions]: https://github.com/apache/opendal/actions?query=branch%3Amain +[latest version]: https://img.shields.io/crates/v/oay.svg +[crates.io]: https://crates.io/crates/oay +[crate downloads]: https://img.shields.io/crates/d/oay.svg +[chat]: https://img.shields.io/discord/1081052318650339399 +[discord]: https://opendal.apache.org/discord + +`oay` is an OpenDAL Gateway that empowers users to access data through their preferred APIs. ## Goal @@ -16,6 +24,12 @@ Our first milestone is to provide S3 APIs. Only `list_object_v2` with `start_after` is supported. +## Branding + +The first and most prominent mentions must use the full form: **Apache OpenDAL™** of the name for any individual usage (webpage, handout, slides, etc.) Depending on the context and writing style, you should use the full form of the name sufficiently often to ensure that readers clearly understand the association of both the OpenDAL project and the OpenDAL software product to the ASF as the parent organization. + +For more details, see the [Apache Product Name Usage Guide](https://www.apache.org/foundation/marks/guide). + ## License and Trademarks Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/bin/ofs/README.md b/bin/ofs/README.md index 11b8f244900a..75ba33df9f8b 100644 --- a/bin/ofs/README.md +++ b/bin/ofs/README.md @@ -1,6 +1,14 @@ -# OpenDAL File System +# Apache OpenDAL™ ofs -OpenDAL File System (ofs) is a userspace filesystem backing by OpenDAL. +[build status]: https://img.shields.io/github/actions/workflow/status/apache/opendal/ci_bin_ofs.yml?branch=main +[actions]: https://github.com/apache/opendal/actions?query=branch%3Amain +[latest version]: https://img.shields.io/crates/v/ofs.svg +[crates.io]: https://crates.io/crates/ofs +[crate downloads]: https://img.shields.io/crates/d/ofs.svg +[chat]: https://img.shields.io/discord/1081052318650339399 +[discord]: https://opendal.apache.org/discord + +`ofs` is a userspace filesystem backing by OpenDAL. ## Status @@ -43,6 +51,12 @@ ofs 'fs://?root=' ofs 's3://?root=&bucket=&endpoint=®ion=&access_key_id=&secret_access_key=' ``` +## Branding + +The first and most prominent mentions must use the full form: **Apache OpenDAL™** of the name for any individual usage (webpage, handout, slides, etc.) Depending on the context and writing style, you should use the full form of the name sufficiently often to ensure that readers clearly understand the association of both the OpenDAL project and the OpenDAL software product to the ASF as the parent organization. + +For more details, see the [Apache Product Name Usage Guide](https://www.apache.org/foundation/marks/guide). + ## License and Trademarks Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/bin/oli/README.md b/bin/oli/README.md index 7e6af6b3bdd7..ed1a409fb0e3 100644 --- a/bin/oli/README.md +++ b/bin/oli/README.md @@ -1,8 +1,14 @@ -# oli +# Apache OpenDAL™ Oli -## What `oli` is +[build status]: https://img.shields.io/github/actions/workflow/status/apache/opendal/ci_bin_oli.yml?branch=main +[actions]: https://github.com/apache/opendal/actions?query=branch%3Amain +[latest version]: https://img.shields.io/crates/v/oli.svg +[crates.io]: https://crates.io/crates/oli +[crate downloads]: https://img.shields.io/crates/d/oli.svg +[chat]: https://img.shields.io/discord/1081052318650339399 +[discord]: https://opendal.apache.org/discord -`oli` stands for OpenDAL Command Line Interface. It aims to provide a unified and user-friendly way to manipulate data stored in various storage services such as Object storage services(s3, azblob, gcs, minio, etc.), Key-Value services(Redis, etcd, TiKV, etc.), Filesystem-like service(HDFS, Azdls, etc.), and also [all the other supported services](https://opendal.apache.org/docs/category/services). +`oli` stands for OpenDAL Command Line Interface. It aims to provide a unified and user-friendly way to manipulate data stored in various storage service. ## How to use `oli` @@ -88,6 +94,12 @@ If you have any questions or suggestions about `oli`, please feel free to open a As `oli` is a part of Apache OpenDAL, you should follow the [CONTRIBUTION](https://github.com/apache/opendal/blob/main/CONTRIBUTING.md) documentation. There are still lots works to do with `oli`, you could track them on this [GitHub Issue](https://github.com/apache/opendal/issues/422). +## Branding + +The first and most prominent mentions must use the full form: **Apache OpenDAL™** of the name for any individual usage (webpage, handout, slides, etc.) Depending on the context and writing style, you should use the full form of the name sufficiently often to ensure that readers clearly understand the association of both the OpenDAL project and the OpenDAL software product to the ASF as the parent organization. + +For more details, see the [Apache Product Name Usage Guide](https://www.apache.org/foundation/marks/guide). + ## License and Trademarks Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/integrations/unftp-sbe/README.md b/integrations/unftp-sbe/README.md index 0bf2f54f7816..36d8be831d63 100644 --- a/integrations/unftp-sbe/README.md +++ b/integrations/unftp-sbe/README.md @@ -1,5 +1,15 @@ # Apache OpenDAL™ unftp Integration +[![Build Status]][actions] [![Latest Version]][crates.io] [![Crate Downloads]][crates.io] [![chat]][discord] + +[build status]: https://img.shields.io/github/actions/workflow/status/apache/opendal/ci_integration_unftp_sbe.yml?branch=main +[actions]: https://github.com/apache/opendal/actions?query=branch%3Amain +[latest version]: https://img.shields.io/crates/v/unftp-sbe-opendal.svg +[crates.io]: https://crates.io/crates/unftp-sbe-opendal +[crate downloads]: https://img.shields.io/crates/d/unftp-sbe-opendal.svg +[chat]: https://img.shields.io/discord/1081052318650339399 +[discord]: https://opendal.apache.org/discord + `unftp-sbe-opendal` is an [unftp](https://crates.io/crates/unftp) `StorageBackend` implementation using opendal. This crate can help you to access ANY storage services with the same ftp API.