diff --git a/README.md b/README.md index 19124b5..653abac 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,12 @@ Designed for streaming media (video, music) over the network. ## Architecture ``` -furumi-server (gRPC + TLS) ←→ furumi-client-core ←→ furumi-mount-linux (FUSE) +furumi-server (gRPC + TLS) ←→ furumi-client-core ←→ furumi-mount-{linux,macos} (FUSE) ``` - **furumi-server** — exposes a directory over gRPC with auto-TLS, Bearer token auth, and Prometheus metrics - **furumi-client-core** — cross-platform gRPC client library with attribute caching -- **furumi-mount-linux** — mounts the remote directory locally via FUSE (read-only) +- **furumi-mount-linux** / **furumi-mount-macos** — mounts the remote directory locally via FUSE (read-only) ## Quick Start @@ -26,12 +26,18 @@ cargo build --release --workspace --token mysecrettoken \ --tls-cert-out /tmp/furumi-ca.pem -# Client — automatically uses TLS, trusts server certificate +# Client (Linux) — automatically uses TLS, trusts server certificate ./target/release/furumi-mount-linux \ --server server-ip:50051 \ --token mysecrettoken \ --mount /mnt/remote +# Client (macOS) +./target/release/furumi-mount-macos \ + --server server-ip:50051 \ + --token mysecrettoken \ + --mount /Volumes/remote + # Use it ls /mnt/remote mpv /mnt/remote/video.mkv @@ -80,6 +86,7 @@ Available at `http:///metrics`: ## Requirements - Linux with `libfuse3-dev` and `pkg-config` (for client) +- macOS with `macFUSE` installed (for macOS client) - Rust 2024 edition ## License