From a23883d20826d743404b6e232fb99184d20c5fac Mon Sep 17 00:00:00 2001
From: Ho 229 <ho229v3666@gmail.com>
Date: Wed, 13 Mar 2024 21:08:20 +0800
Subject: [PATCH] docs(bin/ofs): update README (#4354)

docs: update README
---
 bin/ofs/README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/bin/ofs/README.md b/bin/ofs/README.md
index eaf472caf3a7..82579452dcc1 100644
--- a/bin/ofs/README.md
+++ b/bin/ofs/README.md
@@ -2,6 +2,41 @@
 
 OpenDAL File System (ofs) is a userspace filesystem backing by OpenDAL.
 
+## Status
+
+`ofs` is a work in progress. we only support `fs` and `s3` as backend on `Linux` currently.
+
+## How to use `ofs`
+
+### Install `FUSE` on Linux
+
+```shell
+sudo pacman -S fuse3 --noconfirm # archlinux
+sudo apt-get -y install fuse     # debian/ubuntu
+```
+
+### Install `ofs`
+
+`ofs` could be installed by `cargo`:
+
+```shell
+cargo install ofs
+```
+
+> `cargo` is the Rust package manager. `cargo` could be installed by following the [Installation](https://www.rust-lang.org/tools/install) from Rust official website.
+
+### Mount directory
+
+```shell
+ofs <mount-point> 'fs://?root=<directory>'
+```
+
+### Mount S3 bucket
+
+```shell
+ofs <mount-point> 's3://?root=<path>&bucket=<bucket>&endpoint=<endpoint>&region=<region>&access_key_id=<access-key-id>&secret_access_key=<secret-access-key>'
+```
+
 ## License and Trademarks
 
 Licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0