From 8611096c8028fa6ae9fa7f7609dd5055429307c4 Mon Sep 17 00:00:00 2001 From: zjregee Date: Thu, 13 Jun 2024 20:25:55 +0800 Subject: [PATCH] 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(-) create mode 100644 integrations/fuse3/README.md create mode 100644 integrations/virtiofs/README.md diff --git a/README.md b/README.md index d8f1cd549770..e1b3f6279d37 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 53e83a67c85f..38c8c70d895e 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 000000000000..5a5329ab386d --- /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 000000000000..afb114593b4f --- /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.