Skip to content

Commit 83cd90c

Browse files
1 parent 1a0f936 commit 83cd90c

1 file changed

Lines changed: 36 additions & 28 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 36 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
</td>
66
<td align="left" valign="middle">
77
<h3 align="left">
8-
  🌌
8+
🌌
99
</h3>
1010
</td>
1111
<td align="left" valign="middle">
@@ -31,15 +31,17 @@ Land
3131
</td>
3232
<td align="left" valign="middle">
3333
<h3 align="left">
34-
β€πŸžοΈ
34+
🏞️
3535
</h3>
3636
</td>
3737
</tr>
3838
</table>
3939

4040
---
4141

42-
# **Sky**β€πŸŒŒβ€The UI Component Layer for Landβ€πŸžοΈ
42+
# **Sky** 🌌
43+
44+
The UI Component Layer for Land 🏞️
4345

4446
[![License: CC0-1.0](https://img.shields.io/badge/License-CC0_1.0-lightgrey.svg)](https://github.com/CodeEditorLand/Land/tree/Current/LICENSE)
4547
[![NPM Version](https://img.shields.io/npm/v/@codeeditorland/sky.svg)](https://www.npmjs.com/package/@codeeditorland/sky)
@@ -57,23 +59,23 @@ presentation.
5759

5860
1. **Render UI Components:** Provide a comprehensive set of Astro-based
5961
components that compose the Land editor interface.
60-
2. **Support Multiple Workbench Variants:** Offer four distinct workbench
61-
approaches (A1-A4) for different deployment scenarios.
62+
2. **Support Multiple Workbench Variants:** Offer distinct workbench approaches
63+
(A1-A3) for different deployment scenarios.
6264
3. **Integrate with Wind Services:** Consume `Wind`'s Effect-TS powered services
6365
for state management and backend communication.
6466
4. **Enable Page Routing:** Manage application navigation and page transitions
6567
within the Tauri webview.
6668

6769
---
6870

69-
## Key Featuresβ€πŸ”
71+
## Key Features πŸ”
7072

7173
- **Astro-Based Component Architecture:** Leverages Astro's component islands
7274
architecture for efficient, content-driven UI development with zero JavaScript
7375
by default and selective hydration for interactive components.
7476
- **VSCode UI Compatibility:** Provides multiple workbench approaches that load
7577
and integrate VSCode's core UI components from `@codeeditorland/output`,
76-
ensuring high-fidelity editor experience.
78+
ensuring a high-fidelity editor experience.
7779
- **Wind Service Layer Integration:** Seamlessly consumes `Wind`'s Effect-TS
7880
services for file operations, dialogs, configuration, and state management,
7981
enabling a clean separation between UI and business logic.
@@ -83,13 +85,13 @@ presentation.
8385
- **Flexible Workbench Variants:** Supports multiple workbench approaches
8486
through environment-based selection:
8587
- **A1 (Browser/BrowserProxy):** Browser-based workbench with optional
86-
service proxy
88+
service proxy.
8789
- **A2 (Mountain - RECOMMENDED):** Browser workbench with Mountain-backed
88-
providers
89-
- **A3 (Electron):** Electron workbench with polyfills for VSCode
90+
providers.
91+
- **A3 (Electron):** Electron workbench with polyfills for VSCode.
9092
- **Component Modularity:** Organized into Pages (routes), Workbenches
9193
(components), and Workbench Implementations (BrowserProxy/, Electron/
92-
subdirectories) for clear separation of concerns and maintainability.
94+
subdirectories) for clear separation of concerns.
9395
- **Responsive Design:** Built with CSS and Astro's styling capabilities to
9496
ensure the editor interface adapts to different window sizes and user
9597
preferences.
@@ -108,18 +110,18 @@ presentation.
108110

109111
---
110112

111-
## Deep Dive & Component Breakdownβ€πŸ”¬
113+
## Deep Dive & Component Breakdown πŸ”¬
112114

113-
To understand how `Sky`'s internal components interact, including the Astro
114-
configuration, workbench approaches, and integration with `Wind`, please refer
115+
To understand how `Sky`'s internal components interact β€” including the Astro
116+
configuration, workbench approaches, and integration with `Wind` β€” please refer
115117
to the detailed technical breakdown in the `Documentation/` directory or the
116118
source code comments in [`astro.config.ts`](astro.config.ts) and workbench
117119
components. The source files explain the role of each workbench variant, page
118120
routing, and the build process for bundling Wind modules.
119121

120122
---
121123

122-
## `Sky` in the Land Ecosystemβ€πŸŒŒ + 🏞️
124+
## `Sky` in the Land Ecosystem 🌌 + 🏞️
123125

124126
| Component | Role & Key Responsibilities |
125127
| :--------------------- | :-------------------------------------------------------------------------------------------------------------------------------------- |
@@ -132,7 +134,7 @@ routing, and the build process for bundling Wind modules.
132134

133135
---
134136

135-
## Interaction Flow: Rendering UI from Wind Stateβ€πŸ”„
137+
## Interaction Flow: Rendering UI from Wind State πŸ”„
136138

137139
Here's a step-by-step example of how `Sky` renders the UI based on `Wind`'s
138140
state:
@@ -188,19 +190,19 @@ classDef tauri fill:#f9d,stroke:#333,stroke-width:2px;
188190
classDef mountain fill:#f9f,stroke:#333,stroke-width:2px;
189191
classDef external fill:#ddd,stroke:#666,stroke-dasharray: 5 5;
190192
191-
subgraph "Skyβ€πŸŒŒ (UI Component Layer - Tauri Webview)"
193+
subgraph "Sky 🌌 (UI Component Layer - Tauri Webview)"
192194
Pages["Pages (index, Browser, Electron, Mountain, Isolation)"]:::sky
193195
Workbenches["Workbench Components (Browser, Mountain, Default, NLS)"]:::sky
194196
WorkbenchImpl["Workbench Implementations (BrowserProxy/, Electron/)"]:::sky
195197
end
196198
197-
subgraph "Windβ€πŸƒ (Service Layer - Tauri Webview)"
199+
subgraph "Wind πŸƒ (Service Layer - Tauri Webview)"
198200
PreloadJS["Preload.js (Environment Shim)"]:::wind
199201
WindServices[Wind Effect-TS Services]:::wind
200202
TauriIntegrations[Wind/Tauri Integrations]:::wind
201203
end
202204
203-
subgraph "Tauri Shell & Mountainβ€πŸŒŒβ€(Rust Backend)"
205+
subgraph "Tauri Shell & Mountain 🌌 (Rust Backend)"
204206
TauriWindow[Tauri Window API]:::tauri
205207
TauriEvents[Tauri Event System]:::tauri
206208
MountainCore[Mountain Rust Core]:::mountain
@@ -227,7 +229,7 @@ WorkbenchImpl -- Loads --> VSCodeComponents
227229

228230
---
229231

230-
## Project Structure Overviewβ€πŸ—ΊοΈ
232+
## Project Structure Overview πŸ—ΊοΈ
231233

232234
The `Sky` repository is organized to separate concerns between pages,
233235
workbenches, and components:
@@ -280,9 +282,9 @@ Sky/
280282

281283
---
282284

283-
## Getting Startedβ€πŸš€
285+
## Getting Started πŸš€
284286

285-
### Installation πŸ“₯
287+
### Installation πŸ“₯
286288

287289
To add `Sky` to your project workspace:
288290

@@ -300,10 +302,10 @@ pnpm add @codeeditorland/sky
300302
- `@playform/build`, `@playform/compress`, `@playform/inline`: Build utilities
301303
- `deepmerge-ts`, `dotenv`, `typescript`, `vite`, `zod`: Development utilities
302304

303-
**Note:** `@tauri-apps/api` is accessed transitively through `Wind` service
305+
**Note:** `@tauri-apps/api` is accessed transitively through the `Wind` service
304306
layer rather than as a direct dependency.
305307

306-
### Usage Patternβ€πŸš€
308+
### Usage Pattern πŸš€
307309

308310
`Sky` is primarily used through its page routes and workbench components:
309311

@@ -383,10 +385,11 @@ BrowserProxy=true pnpm run Run
383385
## Licenseβ€βš–οΈ
384386

385387
This project is released into the public domain under the **Creative Commons CC0
386-
Universal** license. You are free to use, modify, distribute, and build upon
387-
this work for any purpose, without any restrictions. For the full legal text,
388-
see the [`LICENSE`](https://github.com/CodeEditorLand/Land/tree/Current/LICENSE)
389-
file.
388+
Universal** license.
389+
390+
You are free to use, modify, distribute, and build upon this work for any
391+
purpose, without any restrictions. For the full legal text, see the
392+
[`LICENSE`](https://github.com/CodeEditorLand/Land/tree/Current/LICENSE) file.
390393

391394
---
392395

@@ -405,6 +408,11 @@ through [NGI0 Commons Fund](https://NLnet.NL/commonsfund), a fund established by
405408
[Next Generation Internet](https://ngi.eu) program. Learn more at the
406409
[NLnet project page](https://NLnet.NL/project/Land).
407410

411+
The project is operated by PlayForm, based in Sofia, Bulgaria.
412+
413+
PlayForm acts as the open-source steward for Code Editor Land under the NGI0
414+
Commons Fund grant.
415+
408416
<table>
409417
<thead>
410418
<tr>

0 commit comments

Comments
Β (0)