Skip to content

Commit 99ca02b

Browse files
committed
docs: bring the feature list up to date with what the template ships
1 parent 24177d9 commit 99ca02b

5 files changed

Lines changed: 19 additions & 6 deletions

File tree

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,11 @@ Quick Start Templates for **[Vite](https://vitejs.dev)** + **[Vue 3](https://vue
2828
- ⚡️ TypeScript support
2929
- ⚡️ Multilingual support
3030
- ⚡️ Support for themes (dark & light)
31-
- ⚡️ Basic layout manager
31+
- ⚡️ Basic layout manager built on Vuetify
3232
- ⚡️ Global state management through the Pinia store
33+
- ⚡️ Tray icon, with an optional floating tray window
34+
- ⚡️ Native file dialog and external link examples over IPC
35+
- ⚡️ Secure by default: context isolation, channel whitelists, CSP and navigation guards
3336
- ⚡️ Quick support through the GitHub community and official documentation
3437

3538
## [Documentation (Getting Started)](https://vutron.cdget.com/installation-and-build/getting-started)

docs/src/en/introduction.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@
1616
- ⚡️ TypeScript support
1717
- ⚡️ Multilingual support
1818
- ⚡️ Support for themes (dark & light)
19-
- ⚡️ Basic layout manager
19+
- ⚡️ Basic layout manager built on Vuetify
2020
- ⚡️ Global state management through the Pinia store
21+
- ⚡️ Tray icon, with an optional floating tray window
22+
- ⚡️ Native file dialog and external link examples over IPC
23+
- ⚡️ Secure by default: context isolation, channel whitelists, CSP and navigation guards
2124
- ⚡️ Quick support through the GitHub community and official documentation

docs/src/ko/introduction.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@
1616
- ⚡️ TypeScript 지원
1717
- ⚡️ 다국어 지원
1818
- ⚡️ 테마 지원 (다크 & 라이트)
19-
- ⚡️ 기본적인 레이아웃 관리
19+
- ⚡️ Vuetify 기반의 기본적인 레이아웃 관리
2020
- ⚡️ Pinia 스토어를 활용한 글로벌 상태 관리
21+
- ⚡️ 트레이 아이콘 지원 (플로팅 트레이 창 옵션 포함)
22+
- ⚡️ IPC를 통한 네이티브 파일 다이얼로그 및 외부 링크 예제
23+
- ⚡️ 기본 적용된 보안 설정: 컨텍스트 격리, 채널 화이트리스트, CSP, 네비게이션 가드
2124
- ⚡️ GitHub 커뮤니티와 공식 문서를 통한 프로젝트 기술지원

docs/src/public/llms.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
> Vutron is a preconfigured template for developing Electron cross-platform desktop apps. It uses Vite + Vue 3 + Electron, and allows you to build a fast development environment with little effort.
44

5-
Vutron ships with hot-reload development, cross-platform builds via electron-builder, TypeScript, automated Playwright testing, i18n (vue-i18n), dark/light themes, a basic layout manager, and global state management with Pinia. The renderer uses Vuetify as its design framework.
5+
Vutron ships with hot-reload development, cross-platform builds via electron-builder, TypeScript, automated Playwright testing, i18n (vue-i18n), dark/light themes, a basic layout manager, a tray icon, and global state management with Pinia. The renderer uses Vuetify as its design framework, and runs with context isolation, whitelisted IPC channels, a content security policy and navigation guards enabled by default.
66

77
- Repository: https://github.com/jooy2/vutron (MIT license)
88
- Create a new project: `npm init vutron`
@@ -21,7 +21,8 @@ Vutron ships with hot-reload development, cross-platform builds via electron-bui
2121
- [Project Structure](https://vutron.cdget.com/project-structures/project-structure): Annotated directory tree of every folder and configuration file in the template.
2222
- [Pre-configured Components](https://vutron.cdget.com/project-structures/pre-configured-components): The frameworks and tools bundled in the template (Vite, Electron, Electron Builder, TypeScript, ESLint, Prettier, Vue, Vue-i18n, Vue-router, Pinia, Vuetify, Playwright).
2323
- [Main vs Renderer Process](https://vutron.cdget.com/electron-how-to/main-and-renderer-process): How the two Electron processes are split, why Node.js APIs are unavailable in the renderer, and how to enable `nodeIntegration`.
24-
- [Preload Script](https://vutron.cdget.com/electron-how-to/preload-script): Whitelisting IPC channels (`mainAvailChannels`, `rendererAvailChannels`) and using the `window.mainApi` API (`send`, `on`, `once`, `off`, `invoke`).
24+
- [Preload Script](https://vutron.cdget.com/electron-how-to/preload-script): Whitelisting IPC channels (`mainSendChannels`, `mainInvokeChannels`, `rendererAvailChannels`) and using the `window.mainApi` API (`send`, `on`, `once`, `off`, `invoke`).
25+
- [Tray Icon](https://vutron.cdget.com/electron-how-to/tray-icon): Configuring the tray through `DEFAULT_WINDOW_OPTIONS.tray`, the context-menu and floating tray-window modes, and how to remove the feature.
2526

2627
## Optional
2728

docs/src/zhHans/introduction.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@
1616
- ⚡️ 支持 TypeScript
1717
- ⚡️ 多语言支持
1818
- ⚡️ 支持主题(暗色和亮色)
19-
- ⚡️ 基本布局管理器
19+
- ⚡️ 基于 Vuetify 的基本布局管理器
2020
- ⚡️ 通过 Pinia 存储进行全局状态管理
21+
- ⚡️ 托盘图标支持(可选的浮动托盘窗口)
22+
- ⚡️ 通过 IPC 实现的原生文件对话框与外部链接示例
23+
- ⚡️ 默认启用的安全设置:上下文隔离、通道白名单、CSP 与导航防护
2124
- ⚡️ 通过 GitHub 社区和官方文档提供快速支持

0 commit comments

Comments
 (0)