Skip to content

Commit e26819b

Browse files
committed
Update README
1 parent 8666095 commit e26819b

File tree

4 files changed

+11
-39
lines changed

4 files changed

+11
-39
lines changed

README.md

+8-39
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# VersionFox(vf)
1+
<p>
2+
<img src="./logo.png" alt="Logo" width="180" height="180">
3+
</p>
4+
<h1 style="margin-top: -40px">VersionFox</h1>
25

36
[![Go Report Card](https://goreportcard.com/badge/github.com/aooohan/version-fox)](https://goreportcard.com/report/github.com/aooohan/version-fox)
47
[![Go Reference](https://pkg.go.dev/badge/github.com/aooohan/version-fox.svg)](https://pkg.go.dev/github.com/aooohan/version-fox)
@@ -11,17 +14,7 @@ sdk via the command line.
1114

1215
### Examples
1316

14-
plugin == sdk
1517
```bash
16-
$ vf add <name> <plugin-url>
17-
$ vf remove <name> (will remove plugins and installed sdk)
18-
$ vf install <name>@<version>
19-
$ vf uninstall <name>@<version>
20-
$ vf use <name>@<version>
21-
$ vf ls [<name>] (list installed sdk)
22-
23-
24-
2518
$ vf install [email protected]
2619
Install [email protected] success!
2720

@@ -51,7 +44,10 @@ $ vf ls node
5144
-> 18.10.0 (current)
5245
```
5346

54-
## Supported SDKs
47+
## TODO
48+
49+
50+
## Supported SDK Plugins
5551

5652
- [x] Node.js https://nodejs.org/dist/
5753
- [ ] Python
@@ -61,10 +57,6 @@ $ vf ls node
6157
- [ ] Ruby
6258
// etc...
6359

64-
## IDEA !!!
65-
66-
- [ ] --local --global
67-
6860
## Contributing
6961

7062
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any
@@ -80,26 +72,3 @@ contributions you make are greatly appreciated.
8072

8173
Distributed under the Apache 2.0 License. See `LICENSE` for more information.
8274

83-
## Storage structure
84-
85-
-> .version-fox
86-
-> env.sh
87-
-> plugin
88-
-> [plugin-name].lua
89-
-> [plugin2-name].lua
90-
-> .cache
91-
-> [sdk1-name]
92-
-> [v-version]
93-
-> [sdk1-name]
94-
-> [v-version]
95-
96-
## Arch
97-
98-
-> SdkManager
99-
-> Handler
100-
-> Source
101-
102-
## TODO
103-
104-
105-

logo.png

473 KB
Loading

script/node.lua

+2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ ARCH_TYPE = ""
77

88
nodeDownloadUrl = "https://nodejs.org/dist/v%s/node-v%s-%s-%s%s"
99

10+
--- https://nodejs.org/dist/index.json
11+
1012
PLUGIN = {
1113
name = "node",
1214
author = "Lihan",

sdk/manager.go

+1
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ func (m *Manager) Uninstall(config Arg) error {
7373
return source.Use(firstVersion)
7474
}
7575

76+
// TODO need to support pagination
7677
func (m *Manager) Search(config Arg) error {
7778
source := m.sdkMap[config.Name]
7879
if source == nil {

0 commit comments

Comments
 (0)