Skip to content

Commit 2685799

Browse files
docs: fix false IPC tagline, correct intro description, remove badge table header
1 parent 6d9445f commit 2685799

1 file changed

Lines changed: 31 additions & 17 deletions

File tree

README.md

Lines changed: 31 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,21 @@
1-
<table><tr>
2-
<td colspan="1"> <h3 align="center"> <picture>
3-
<source media="(prefers-color-scheme: dark)" srcset="https://PlayForm.Cloud/Dark/Image/GitHub/Land.svg">
4-
<source media="(prefers-color-scheme: light)" srcset="https://PlayForm.Cloud/Image/GitHub/Land.svg">
5-
<img width="28" alt="Land Logo" src="https://PlayForm.Cloud/Image/GitHub/Land.svg">
6-
</picture> </h3> </td> <td colspan="3" valign="top"> <h3 align="center"> Wind 🍃
7-
</h3> </td>
8-
</tr></table>
1+
<table>
2+
<tr>
3+
<td align="left" valign="middle">
4+
<h3 align="left">
5+
<a href="https://Editor.Land" target="_blank">
6+
<picture>
7+
<source media="(prefers-color-scheme: dark)" srcset="https://PlayForm.Cloud/Dark/Image/GitHub/Land.svg">
8+
<source media="(prefers-color-scheme: light)" srcset="https://PlayForm.Cloud/Image/GitHub/Land.svg">
9+
<img width="28" alt="Land Logo" src="https://PlayForm.Cloud/Image/GitHub/Land.svg">
10+
</picture>
11+
</a>
12+
</h3>
13+
</td>
14+
<td align="left" valign="middle">
15+
<h3 align="left">Wind 🍃</h3>
16+
</td>
17+
</tr>
18+
</table>
919

1020
---
1121

@@ -14,10 +24,12 @@
1424
The Breath of Land: VSCode Environment & Services for Tauri
1525

1626
> **VS Code's workbench lives in the Chromium renderer. Every panel interaction
17-
> that touches files or state crosses the Electron IPC bridge twice: serialize
18-
> to JSON, send over a pipe, deserialize on the other side.**
27+
> that touches files or state crosses the Electron IPC bridge: serialize to
28+
> JSON, send over a pipe, deserialize on the other side — in an untyped,
29+
> unstructured way.**
1930
20-
_"No Electron IPC proxy. Workbench actions hit the OS directly."_
31+
_"Typed, Effect-TS native IPC. Workbench actions go through Tauri commands to
32+
Rust handlers, not an Electron JSON pipe."_
2133

2234
[![License: CC0-1.0](https://img.shields.io/badge/License-CC0_1.0-lightgrey.svg)](https://github.com/CodeEditorLand/Wind/tree/Current/LICENSE)
2335
[![NPM Version](https://img.shields.io/npm/v/@codeeditorland/wind.svg)](https://www.npmjs.com/package/@codeeditorland/wind)
@@ -29,16 +41,18 @@ layer** that allows `Sky` (Land's VSCode-based UI) to breathe and function
2941
within the **Tauri** shell. **Wind** meticulously recreates essential parts of
3042
the VSCode renderer environment, provides robust implementations of core
3143
services (like file dialogs and configuration), and integrates seamlessly with
32-
the `Mountain` backend via Tauri APIs. It replaces Electron-based
33-
implementations with high-performance, OS-native equivalents, all underpinned by
34-
**Effect-TS** for resilience and type safety.
44+
the `Mountain` backend via Tauri IPC. Rather than routing through an Electron
45+
IPC pipe with untyped JSON, Wind dispatches through typed Tauri commands whose
46+
handlers live in Mountain's Rust core — all underpinned by **Effect-TS** for
47+
resilience and type safety.
3548

3649
**Wind** is engineered to:
3750

3851
1. **Emulate the VSCode Sandbox:** Through a sophisticated
3952
[`Preload.ts`](https://github.com/CodeEditorLand/Wind/tree/Current/Source/Preload.ts)
4053
script, it shims critical Electron and Node.js APIs that VSCode's workbench
41-
code expects, creating a compatible execution context.
54+
code expects, creating a compatible execution context inside the Tauri
55+
WebView.
4256
2. **Implement Core VSCode Services:** It provides frontend implementations for
4357
key VSCode services via
4458
[`Polyfills/NativeModulePolyfill.ts`](https://github.com/CodeEditorLand/Wind/tree/Current/Source/Polyfills/NativeModulePolyfill.ts),
@@ -79,7 +93,7 @@ implementations with high-performance, OS-native equivalents, all underpinned by
7993
| **Compatibility** | Provide a high-fidelity VSCode renderer environment to maximize `Sky`'s reusability and minimize changes needed for VSCode UI components. | `Preload.ts`, `Polyfills/` |
8094
| **Modularity** | Components (preload, services, integrations) are organized into distinct, cohesive modules for clarity and maintainability. | `Effect/`, `Types/`, `Bootstrap/` |
8195
| **Robustness** | Leverage `Effect-TS` for all service implementations and asynchronous operations, ensuring predictable error handling and composability. | All `Effect/` services with `Layer` and `Tag` patterns |
82-
| **Abstraction** | Create a clean layer over Tauri APIs, isolating platform specifics and simplifying their usage within the application. | `Preload.ts`, `Effect/IPC/`, `Effect/Mountain/` |
96+
| **Abstraction** | Create a clean layer over Tauri APIs, replacing the untyped Electron IPC pipe with typed Tauri commands whose handlers live in Rust. | `Preload.ts`, `Effect/IPC/`, `Effect/Mountain/` |
8397
| **Integration** | Seamlessly connect `Sky`'s frontend requests with `Mountain`'s backend capabilities through Tauri's `invoke`/event system. | `Preload.ts` (ipcRenderer shim), `Effect/Mountain/` |
8498

8599
---
@@ -96,7 +110,7 @@ for the complete module exports and layer compositions.
96110

97111
---
98112

99-
## `Wind` in the Land Ecosystem&#x2001;🍃 + 🏞️
113+
## `Wind` in the Land Ecosystem&#x2001;🍃 + 🏞️
100114

101115
This diagram illustrates `Wind`'s central role between `Sky` (the UI) and the
102116
Tauri/`Mountain` (backend) environment.

0 commit comments

Comments
 (0)