Skip to content

Commit 79071db

Browse files
committed
docs: update readme
1 parent db3837e commit 79071db

1 file changed

Lines changed: 11 additions & 9 deletions

File tree

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,17 @@ Here's a closer look at the Phoenix VFS organization:
2525
- **Windows Example**: `/tauri/c/Program Files/` could represent the C drive's "Program Files" directory.
2626
- **Linux/macOS Example**: `/tauri/usr/bin/` might be an accessible directory, akin to native paths you'd expect on these platforms.
2727

28-
By adopting Phoenix VFS, you're not just leveraging a file system; you're integrating a dynamic, adaptable layer that bridges the web and native worlds, making your web applications more powerful and efficient.
29-
30-
---
31-
32-
You can then continue with installation instructions, usage, and other sections relevant to your library in the README.
28+
- **Node Websocket Connector Integration**:
29+
- The `/tauri/` paths can be accessed via websockets. This integration is much more
30+
performant than tauri's fs rust APIs(generally 4x faster and 10x faster for large files).
31+
- As we use websockets to connection to a node process that executes the actual fs operations,
32+
the ws backed `/tauri/` apis are available in all web/shared/service workers.
33+
- This is recommended to use in main browser window as well, as this will releive the main thread
34+
of tauri fs access apis that typically leads to blocking/freezing js window on large file access.
35+
- Supports filesystem watcher APIs. On all other endpoints, the virtual watchers are only capable of
36+
emitting file change events on files that has been modified within its window/browser only.
37+
38+
By adopting Phoenix VFS, you're not just leveraging a file system; you're integrating a dynamic, adaptable layer that bridges the web and native worlds, making your web applications more powerful and reduces development time and costs.
3339

3440
<!-- TOC -->
3541
* [Phoenix Browser Virtual File System](#phoenix-browser-virtual-file-system)
@@ -169,10 +175,6 @@ Then:
169175
2. Copy all `#[tauri::command]` from `src-tauri/src/main.rs` to your tauri main file.
170176
3. Update your `tauri::Builder::default()` section in your tauri `main fn()`
171177

172-
Certainly! Here's a polished presentation for a GitHub `README.md` for your project:
173-
174-
---
175-
176178
## Usage in Tauri with Node Websocket Connector
177179

178180
Tauri APIs are accessible exclusively from the main thread.

0 commit comments

Comments
 (0)