Skip to content

Commit 7423f8e

Browse files
committed
docs: improve structure a bit
1 parent 9daf064 commit 7423f8e

File tree

3 files changed

+11
-17
lines changed

3 files changed

+11
-17
lines changed

docs/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<a style="color:#ff637e" href="https://github.com/freesmteam/kaede">Kaede</a>
77
</h1>
88

9-
[WIP] An extensible Tauri-based Minecraft launcher written in Vue and Rust
9+
An extensible Tauri-based Minecraft launcher written with Vue and Tauri
1010

1111
<p align="center">
1212
<strong>English</strong> | <a style="color:#ff637e" href="./README.ru.md">Русский</a>
@@ -25,13 +25,13 @@ Kaede is not even in a development stage yet. Check the [plan](./PLAN.md) to see
2525

2626
## Contributing
2727

28-
You don't need to know Rust to contribute to this project. Almost everything was written in TypeScript using Tauri API. These files will help you:
28+
You don't need a Rust knowledge to contribute to this project. Almost everything was written in TypeScript using Tauri API. These files will help you:
2929

3030
- [README for JavaScript-related code](../src/README.md) (the most important one)
3131
- [README for Rust-related code](../src-tauri/README.md)
3232
- [Contributing Guidelines](./CONTRIBUTING.md)
3333

34-
I also add a lot of comments in the code.
34+
I also leave a lot of comments in the code.
3535

3636
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
3737

@@ -44,7 +44,7 @@ Isolation was done using the [Secure ECMAScript](https://github.com/endojs/endo)
4444
Interactive Live2Ds were taken from [Z_DK's Steam Workshop](https://steamcommunity.com/id/xingsuileixi/myworkshopfiles/?appid=431960)
4545

4646
<details>
47-
We need to take care of DOM script tags that plugins can add when have the DOM access. Otherwise, this sandbox can be escaped. Maybe we can overwrite the `document.createElement` before freezing it? And just to be sure, listen for `head` element changes for possible script tag additions?
47+
I need to take care of DOM script tags that plugins can add when have the DOM access. Otherwise, this sandbox can be escaped. Maybe I can overwrite the `document.createElement` before freezing it? And just to be sure, listen for `head` element changes for possible script tag additions?
4848

4949
Update: Seems like giving DOM access to the compartment basically ruins the whole purpose of plugin isolation, since one can add a JS code to any DOM element that will be executed in the global scope.
5050

@@ -160,7 +160,7 @@ If you found a bug or want to suggest a feature, please open an issue in [GitHub
160160

161161
See [Tauri v2 Prerequisites](https://v2.tauri.app/start/prerequisites/).
162162

163-
We also recommend installing [bun](https://bun.sh/).
163+
I also recommend installing [bun](https://bun.sh/).
164164

165165
Once you are ready, clone this repository:
166166

src/App.vue

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
<script setup lang="ts">
22
import Layout from "@/components/layout/Layout.vue";
3+
import Router from "@/components/layout/Router.vue";
34
import ErrorBoundary from "@/components/handlers/ErrorBoundary.vue";
5+
import GlobalError from "@/components/statuses/GlobalError.vue";
6+
import ExtensionsError from "@/components/statuses/ExtensionsError.vue";
7+
import NonBundledClasses from "@/components/misc/NonBundledClasses.vue";
48
import { provide, shallowReactive, nextTick, defineAsyncComponent } from "vue";
5-
import Router from "@/components/layout/Router.vue";
69
import {
710
ApplicationNamespace, ContextMenuItems,
811
GlobalStatesChangerContextKey,
@@ -15,18 +18,9 @@ import type {
1518
} from "@/types/application/global-states.type.ts";
1619
import { HookMappings } from "@/constants/mappings.ts";
1720
import type { ExtensionStatusType } from "@/types/extensions/hook-return.type.ts";
18-
import GlobalError from "@/components/statuses/GlobalError.vue";
19-
import ExtensionsError from "@/components/statuses/ExtensionsError.vue";
20-
import NonBundledClasses from "@/components/misc/NonBundledClasses.vue";
2121
import { RouteItems } from "@/constants/routes.ts";
2222
import { capitalize } from "@/lib/helpers/capitalize.ts";
2323
import { log } from "@/lib/handlers/log.ts";
24-
// import { Command } from "@tauri-apps/plugin-shell";
25-
// import { initializeLauncher } from "@/lib/main/initialize-launcher.ts";
26-
// import "ses";
27-
// eslint-disable-next-line unicorn/prefer-node-protocol
28-
// import { Buffer } from "buffer";
29-
// import ShadowRealm from "shadowrealm-api";
3024
3125
const LogViewer = defineAsyncComponent(
3226
() => import("@/components/logging/LogViewer.vue"),

src/__mocks__/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
[README for JavaScript-related code](../README.md)
1+
`[README for JavaScript-related code](../README.md)
22

3-
# Vitest mocks
3+
`# Vitest mocks
44

55
This folder contains a code to imitate some libraries behaviour (for example, Tauri) in the `Vitest` testing environment.
66

0 commit comments

Comments
 (0)