You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@opendal.apache.org by xu...@apache.org on 2024/06/13 13:27:18 UTC

(opendal) branch main updated: docs: update readme for fuse3_opendal & virtiofs_opendal (#4730)

This is an automated email from the ASF dual-hosted git repository.

xuanwo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/opendal.git


The following commit(s) were added to refs/heads/main by this push:
     new c82dc139e7 docs: update readme for fuse3_opendal & virtiofs_opendal (#4730)
c82dc139e7 is described below

commit c82dc139e7478ac96a90c49dc8e5326ecc057d75
Author: zjregee <zj...@gmail.com>
AuthorDate: Thu Jun 13 21:27:12 2024 +0800

    docs: update readme for fuse3_opendal & virtiofs_opendal (#4730)
    
    update readme
---
 README.md                       | 10 ++++++----
 integrations/README.md          |  4 ++++
 integrations/fuse3/README.md    |  3 +++
 integrations/virtiofs/README.md |  3 +++
 4 files changed, 16 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index d8f1cd5497..e1b3f6279d 100644
--- a/README.md
+++ b/README.md
@@ -37,10 +37,12 @@ OpenDAL offers a unified data access layer, empowering users to seamlessly and e
 
 ## For *ANY* integrations
 
-| Name                                                                | Description                                                                                | Release                                                                                                        | 
-|---------------------------------------------------------------------|--------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------| 
-| [dav-server-opendalfs](integrations/dav-server/README.md)           | Access data via integrations to [dav-server-rs](https://github.com/messense/dav-server-rs) | [![](https://img.shields.io/crates/v/dav-server-opendalfs.svg)](https://crates.io/crates/dav-server-opendalfs) |
-| [object_store_opendal](integrations/object_store/README.md) | Access data via integrations to [object_store](https://docs.rs/object_store)               | [![](https://img.shields.io/crates/v/object_store_opendal.svg)](https://crates.io/crates/object_store_opendal) |
+| Name                                                        | Description                                                  | Release                                                      |
+| ----------------------------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| [dav-server-opendalfs](integrations/dav-server/README.md)   | Access data via integrations to [dav-server-rs](https://github.com/messense/dav-server-rs) | [![](https://img.shields.io/crates/v/dav-server-opendalfs.svg)](https://crates.io/crates/dav-server-opendalfs) |
+| [object_store_opendal](integrations/object_store/README.md) | Access data via integrations to [object_store](https://docs.rs/object_store) | [![](https://img.shields.io/crates/v/object_store_opendal.svg)](https://crates.io/crates/object_store_opendal) |
+| [fuse3_opendal](integrations/fuse3/README.md)               | Access data via integrations to [fuse3](https://docs.rs/fuse3) | -                                                            |
+| [virtiofs_opendal](integrations/virtiofs/README.md)         | Access data via integrations to [vhost-user-backend](https://docs.rs/vhost-user-backend) | -                                                            |
 
 ## For *ANY* services
 
diff --git a/integrations/README.md b/integrations/README.md
index 53e83a67c8..38c8c70d89 100644
--- a/integrations/README.md
+++ b/integrations/README.md
@@ -7,3 +7,7 @@ This folder contains the integrations for OpenDAL. Integrations are used to inte
 - [`object_store_opendal`](object_store/README.md): Use OpenDAL as a backend for the [object_store](https://docs.rs/object_store/latest/object_store/).
 
 - [`dav-server-opendalfs`](dav-server/README.md): Use OpenDAL as a backend to access data in various service with WebDAV protocol.
+
+- [`fuse3_opendal`](fuse3/README.md): Use OpenDAL as a backend to access data in various services with FUSE protocol.
+
+- [`virtiofs_opendal`](virtiofs/README.md): Use OpenDAL as a backend to access data in various services with VirtioFS protocol.
diff --git a/integrations/fuse3/README.md b/integrations/fuse3/README.md
new file mode 100644
index 0000000000..5a5329ab38
--- /dev/null
+++ b/integrations/fuse3/README.md
@@ -0,0 +1,3 @@
+# fuse3_opendal
+
+`fuse3_opendal` is an integration which uses OpenDAL as a backend to access data in various services with FUSE protocol.
diff --git a/integrations/virtiofs/README.md b/integrations/virtiofs/README.md
new file mode 100644
index 0000000000..afb114593b
--- /dev/null
+++ b/integrations/virtiofs/README.md
@@ -0,0 +1,3 @@
+# virtiofs-opendal
+
+`virtiofs_opendal` is an integration which uses OpenDAL as a backend to access data in various services with VirtioFS protocol.