Improve README framing and add issue/label maintainer tooling
This commit is contained in:
Sebastian Palencsar
72
README.md
72
README.md
@@ -14,28 +14,81 @@
|
||||
|
||||
---
|
||||
|
||||
## ⚡ Why deskify?
|
||||
## Why Deskify Exists
|
||||
|
||||
The original [Nativefier](https://github.com/nativefier/nativefier) project (Node.js/Electron) was an incredible tool, but it is now unmaintained and deprecated. Furthermore, packaging an entire Chromium V8 engine for *every single web app* you create consumes massive amounts of RAM and disk space.
|
||||
Web apps are now core tools, but Linux desktops still treat them like second-class citizens.
|
||||
|
||||
**deskify** solves this by leveraging [Tauri](https://tauri.app/). Instead of bundling a heavy browser engine, it uses your native system webview (e.g., `webkit2gtk` on Linux).
|
||||
- Electron-based wrappers solve distribution, but often at high RAM/disk cost.
|
||||
- PWAs help in some browsers, but desktop integration is inconsistent across environments.
|
||||
- The original [Nativefier](https://github.com/nativefier/nativefier) proved the need, but it is now unmaintained.
|
||||
|
||||
## 🚧 Project Status (Alpha / Early MVP)
|
||||
`deskify` takes a Linux-first approach: it turns a website into a native-feeling desktop app using [Tauri](https://tauri.app/) and the system webview (for example `webkit2gtk`) instead of bundling a full browser engine per app.
|
||||
|
||||
## How Deskify Works Today (Alpha / MVP)
|
||||
|
||||
`deskify` is ready for public use and testing as an **early MVP**, but it is **not production-hardened yet**.
|
||||
|
||||
- **Platform scope:** Linux only
|
||||
- **Build model:** `deskify` compiles a local Tauri wrapper app on your machine
|
||||
- **First build can take a while:** Rust crates + Tauri build steps may need to compile
|
||||
- **Test coverage:** currently limited (core behavior is implemented, but automated coverage is still growing)
|
||||
- **Current architecture:** one generated Tauri wrapper project per app
|
||||
- **Build model:** `deskify` compiles the wrapper locally on your machine
|
||||
- **Why this MVP design:** simpler debugging, isolated failures, low contributor complexity
|
||||
- **Tradeoff:** build time and distro-specific setup issues become user-facing
|
||||
- **Test coverage:** currently limited (core behavior is implemented, automated coverage is growing)
|
||||
|
||||
### MVP Architecture (Today)
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
A[deskify CLI] --> B[Generate temporary Tauri wrapper project]
|
||||
B --> C[Fetch or copy icon]
|
||||
C --> D[Write tauri.conf.json + source files]
|
||||
D --> E[Run cargo tauri build locally]
|
||||
E --> F[Install binary to local executable dir]
|
||||
F --> G[Install icon + .desktop entry]
|
||||
G --> H[Launch from Linux app menu]
|
||||
```
|
||||
|
||||
### Known Limitations
|
||||
|
||||
- Requires Tauri/Linux system dependencies to be installed locally before `deskify build`
|
||||
- Generated app build success can vary by distro/system setup (WebKitGTK/Tauri prerequisites)
|
||||
- No official cross-platform support (Windows/macOS) yet
|
||||
- GitHub Releases / binary automation for `deskify` itself may lag behind source updates during early MVP
|
||||
|
||||
### 🌟 Features
|
||||
## Where Deskify Is Going
|
||||
|
||||
Deskify aims to make web applications **first-class Linux desktop applications**.
|
||||
|
||||
Planned evolution (direction, not promise):
|
||||
|
||||
- Shared runtime model for multiple apps
|
||||
- Per-app config and icon installs without full rebuilds
|
||||
- Stronger Linux desktop integration (deployment, automation, kiosk/admin workflows)
|
||||
- Better distro compatibility guidance and troubleshooting
|
||||
|
||||
The current per-app build approach is intentional for the MVP. The goal is to keep it simple now while making the longer-term direction visible.
|
||||
|
||||
### Planned Evolution (Concept)
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
A[deskify CLI] --> B[deskify runtime binary]
|
||||
A --> C[App config files]
|
||||
A --> D[Icons + .desktop entries]
|
||||
C --> E[apps/chatgpt.json]
|
||||
C --> F[apps/netflix.json]
|
||||
B --> G[Load app config at launch]
|
||||
G --> H[Open site in system webview]
|
||||
D --> I[Linux app menu integration]
|
||||
```
|
||||
|
||||
## Why Not Just Use Flatpak Web Apps / PWAs / Electron?
|
||||
|
||||
- **Electron wrappers:** powerful, but often heavy for simple single-site desktop apps
|
||||
- **PWAs:** useful when available, but integration and behavior vary by browser/desktop environment
|
||||
- **Flatpak web app approaches:** can be valid, but `deskify` targets a CLI-driven, system-native, admin-friendly workflow with minimal runtime overhead
|
||||
|
||||
### Key Features
|
||||
- **Extremely Lightweight:** Generated binaries are tiny (~4-6 MB) and RAM consumption is minimal.
|
||||
- **Automatic Icon Fetching:** Scrapes high-quality 128x128 favicons automatically using the Google Favicon API.
|
||||
- **XDG-Compliant System Integration:** Safely creates `.desktop` entries in `~/.local/share/applications` and manages application icons in `~/.local/share/icons/hicolor/`.
|
||||
@@ -139,6 +192,7 @@ You can view all applications generated by `deskify`:
|
||||
deskify list
|
||||
```
|
||||
*Output:*
|
||||
|
||||
```text
|
||||
Installed Deskify Apps:
|
||||
- ChatGPT (Internal ID: chatgpt)
|
||||
@@ -179,7 +233,7 @@ Expected: clean validation error and no unintended file deletion.
|
||||
- Start with **source-first** releases (repository + tags)
|
||||
- Add automated binary releases later via GitHub Actions
|
||||
|
||||
For the first public launch, tagging `v0.1.0-alpha.1` is a sensible default.
|
||||
For the current public alpha, use `v0.1.0-alpha.2` (and continue with `v0.1.0-alpha.N` for follow-up releases).
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user