diff --git a/README.md b/README.md index cda2941..2cc772c 100644 --- a/README.md +++ b/README.md @@ -18,13 +18,10 @@ 4. Provides a github action template to automatically generate package.zip and upload to new release -> [!TIP] -> You can also use our maintained [siyuan-plugin-cli](https://www.npmjs.com/package/siyuan-plugin-cli) command-line tool to directly build plugins in your local terminal. +> [!NOTE] +> The current template case is based on `svelte4` version, we maintain an experimental template in the `svelte5` branch, which upgrades Svelte to 5.x version. > -> Additionally, for the `make-link` related commands mentioned in this plugin, all future updates will be made in [siyuan-plugin-cli](https://www.npmjs.com/package/siyuan-plugin-cli). -> -> The built-in `make-link` scripts may also be removed in a future version, in favor of using the `siyuan-plugin-cli` tool, aiming to simplify the workload of maintaining multiple plugin templates. - +> In the future, we will switch the default main branch to svelte5. ## Get started @@ -36,6 +33,13 @@ 5. Execute `pnpm run dev` for real-time compilation. 6. Open the marketplace in SiYuan and enable the plugin in the download tab. +> [!TIP] +> You can also use our maintained [siyuan-plugin-cli](https://www.npmjs.com/package/siyuan-plugin-cli) command-line tool to directly build plugins in your local terminal. +> +> Additionally, for the `make-link` related commands mentioned in this plugin, all future updates will be made in [siyuan-plugin-cli](https://www.npmjs.com/package/siyuan-plugin-cli). +> +> The built-in `make-link` scripts may also be removed in a future version, in favor of using the `siyuan-plugin-cli` tool, aiming to simplify the workload of maintaining multiple plugin templates. + ### Setting the Target Directory for the make-link Command The `make-link` command creates a symbolic link that binds your `dev` directory to the SiYuan plugin directory. You can configure the target SiYuan workspace and create the symbolic link in three ways: diff --git a/README_zh_CN.md b/README_zh_CN.md index 4cdb705..f5815fd 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -16,6 +16,11 @@ 4. 提供一个github action 模板,能自动生成package.zip并上传到新版本中 +> [!NOTE] +> 当前模板案例基于 `svelte4` 版本,我们在 `svelte5` 分支中维护了一个实验性模板,将 Svelte 升级至 5.x 版本。 +> +> 未来我们会将主分支默认版本切换至 svelte5。 + ## 开始 1. 通过 Use this template 按钮将该库文件复制到你自己的库中,请注意库名和插件名称一致,默认分支必须为 `main`