Skip to content

Commit

Permalink
doc: update for 0.3.0 (#152)
Browse files Browse the repository at this point in the history
* doc: update for 3.0

* update readme

* update
  • Loading branch information
aooohan authored Apr 1, 2024
1 parent af89f70 commit 2aaf541
Show file tree
Hide file tree
Showing 37 changed files with 2,843 additions and 122 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Invoke-Expression "$(vfox activate pwsh)"
#### 3. Add an SDK plugin
```bash
$ vfox add nodejs/nodejs
$ vfox add nodejs
```

#### 4. Install a runtime
Expand All @@ -84,19 +84,19 @@ See [vfox.lhan.me](https://vfox.lhan.me) for full documentation.

Our future plans and high priority features and enhancements are:

- [ ] Refactoring the plugin mechanism:
- [x] Refactoring the plugin mechanism:
- Introducing plugin templates to facilitate multi-file plugin development.
- Establishing a global registry (similar to `NPM Registry` or `Scoop Main Bucket`) to provide a unified entry point for plugin distribution.
- Decomposing the existing plugin repository into individual repositories, one for each plugin.
- [ ] Allowing the switching of registry addresses.
- [X] Allowing the switching of registry addresses.
- [ ] Plugin capabilities: Parsing legacy configuration files, such as `.nvmrc`, `.node-version`, `.sdkmanrc`, etc.
- [ ] Plugin capabilities: Allowing plugins to load installed runtimes and provide information about the runtime.

## Supported Plugins

> If you have installed `vfox`, you can view all available plugins with the `vfox available` command.
[![plugins](https://skillicons.dev/icons?i=java,kotlin,nodejs,flutter,dotnet,python,dart,golang,gradle,maven,zig,deno&theme=light)](https://github.com/version-fox/version-fox-plugins)
[![plugins](https://skillicons.dev/icons?i=java,kotlin,nodejs,flutter,dotnet,python,dart,golang,gradle,maven,zig,deno&theme=light)](https://vfox.lhan.me/plugins/available.html)

For more details, see the [version-fox-plugins](https://github.com/version-fox/version-fox-plugins)

Expand Down
8 changes: 4 additions & 4 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Invoke-Expression "$(vfox activate pwsh)"
#### 3.添加插件
```bash
$ vfox add nodejs/nodejs
$ vfox add nodejs
```

#### 4. 安装运行时
Expand All @@ -80,18 +80,18 @@ $ node -v

> 如果您已经安装了 `vfox`,您可以使用 `vfox available` 命令查看所有可用的插件。
[![plugins](https://skillicons.dev/icons?i=java,kotlin,nodejs,flutter,dotnet,python,dart,golang,gradle,maven,zig,deno&theme=light)](https://github.com/version-fox/version-fox-plugins)
[![plugins](https://skillicons.dev/icons?i=java,kotlin,nodejs,flutter,dotnet,python,dart,golang,gradle,maven,zig,deno&theme=light)](https://vfox.lhan.me/zh-hans/plugins/available.html)

详细内容,请看 [version-fox-plugins](https://github.com/version-fox/version-fox-plugins)

## 路线图

我们未来的计划以及高度优先的功能和增强功能是:
- [ ] 重构插件机制:
- [X] 重构插件机制:
- 增加插件模板, 允许多文件开发插件
- 增加全局注册表(类似于:`NPM Registry``Scoop Main Bucket`), 为插件分发提供统一入口
- 拆分现有的插件仓库, 一个插件一个仓库
- [ ] 允许切换注册表地址
- [X] 允许切换注册表地址
- [ ] 插件能力: 允许插件解析旧版本的配置文件. 例如: `.nvmrc`, `.node-version`, `.sdkmanrc`
- [ ] 插件能力: 允许插件加载已安装的运行时, 并提供运行时的信息

Expand Down
1 change: 1 addition & 0 deletions docs/.vitepress/cache/deps/@theme_index.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/.vitepress/cache/deps/@theme_index.js.map

Large diffs are not rendered by default.

29 changes: 19 additions & 10 deletions docs/.vitepress/cache/deps/_metadata.json
Original file line number Diff line number Diff line change
@@ -1,49 +1,55 @@
{
"hash": "5a9d927a",
"hash": "c44299a9",
"configHash": "b25d5b92",
"lockfileHash": "2ef17b39",
"browserHash": "4b5ba99b",
"lockfileHash": "eff6125a",
"browserHash": "4861eb3f",
"optimized": {
"vue": {
"src": "../../../node_modules/vue/dist/vue.runtime.esm-bundler.js",
"file": "vue.js",
"fileHash": "38d48a69",
"fileHash": "d1bb3707",
"needsInterop": false
},
"vitepress > @vue/devtools-api": {
"src": "../../../node_modules/@vue/devtools-api/dist/index.js",
"file": "vitepress___@vue_devtools-api.js",
"fileHash": "02446c54",
"fileHash": "c819d541",
"needsInterop": false
},
"vitepress > @vueuse/core": {
"src": "../../../node_modules/@vueuse/core/index.mjs",
"file": "vitepress___@vueuse_core.js",
"fileHash": "a929f573",
"fileHash": "d3a2931b",
"needsInterop": false
},
"vitepress > @vueuse/integrations/useFocusTrap": {
"src": "../../../node_modules/@vueuse/integrations/useFocusTrap.mjs",
"file": "vitepress___@vueuse_integrations_useFocusTrap.js",
"fileHash": "ae2f9429",
"fileHash": "5acf36a8",
"needsInterop": false
},
"vitepress > mark.js/src/vanilla.js": {
"src": "../../../node_modules/mark.js/src/vanilla.js",
"file": "vitepress___mark__js_src_vanilla__js.js",
"fileHash": "43592ac6",
"fileHash": "763a016f",
"needsInterop": false
},
"vitepress > minisearch": {
"src": "../../../node_modules/minisearch/dist/es/index.js",
"file": "vitepress___minisearch.js",
"fileHash": "c2666b60",
"fileHash": "20b60ae3",
"needsInterop": false
},
"@theme/index": {
"src": "../../../node_modules/vitepress/dist/client/theme-default/index.js",
"file": "@theme_index.js",
"fileHash": "1ad7640f",
"fileHash": "425c8599",
"needsInterop": false
},
"axios": {
"src": "../../../node_modules/axios/index.js",
"file": "axios.js",
"fileHash": "f47f47ab",
"needsInterop": false
}
},
Expand All @@ -53,6 +59,9 @@
},
"chunk-Z6B2QTD3": {
"file": "chunk-Z6B2QTD3.js"
},
"chunk-CSAU5B4Q": {
"file": "chunk-CSAU5B4Q.js"
}
}
}
Loading

0 comments on commit 2aaf541

Please sign in to comment.