You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+40-8Lines changed: 40 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,23 +1,51 @@
1
-
# echocat's mongod MISE plugin
1
+
# echocat's mongod vfox plugin
2
2
3
-
This provides a MISE plugin to use `mongod` and `mongos`in your project as tools.
3
+
This provides a vfox plugin to use `mongod` and `mongos`inside your project as tools. It is compatible with [vfox](https://vfox.dev/) itself and [MISE](https://mise.jdx.dev).
4
4
5
5
## TOC
6
6
7
-
1.[Usage](#usage)
7
+
1.[Usage](#usage) ...with [vfox](#with-vfox) or [MISE](#with-mise)
You have two options, either use it as a [vfox plugin / directly as a MISE tool](#vfox-plugin) or as an [MISE plugin](#mise-plugin).
15
43
16
-
### vfox Plugin
44
+
#### vfox Plugin
17
45
18
46
1. Add a handy alias
19
47
```shell
20
-
mise aliasset vfox:echocat/mise-plugin-mongod mongod
48
+
mise aliasset vfox:echocat/vfox-mongod mongod
21
49
```
22
50
23
51
2. Install the tool into your project
@@ -35,11 +63,11 @@ You have two options, either use it as a [vfox plugin / directly as a MISE tool]
35
63
mise exec -- mongod --version
36
64
```
37
65
38
-
### MISE Plugin
66
+
#### MISE Plugin
39
67
40
68
1. Install the plugin (ℹ️ this only needs to be done once per user - **not** per project - it will be installed inside your current user)
41
69
```shell
42
-
mise plugin install mongod https://github.com/echocat/mise-plugin-mongod
70
+
mise plugin install mongod https://github.com/echocat/vfox-mongod
43
71
```
44
72
45
73
2. Install the tool into your project
@@ -59,6 +87,10 @@ You have two options, either use it as a [vfox plugin / directly as a MISE tool]
59
87
60
88
## FAQ
61
89
90
+
### What is vfox?
91
+
92
+
See [vfox.dev](https://vfox.dev)
93
+
62
94
### What is MISE?
63
95
64
96
See [mise.jdx.dev](https://mise.jdx.dev)
@@ -69,7 +101,7 @@ It uses the [downloads.mongodb.org/full.json](https://downloads.mongodb.org/full
69
101
70
102
## Contributing
71
103
72
-
**mise-plugin-mongod** is an open source project by [echocat](https://echocat.org). So if you want to make this project even better, you can contribute to this project on [Github](https://github.com/echocat/mise-plugin-mongod) by [fork us](https://github.com/echocat/mise-plugin-mongod/fork).
104
+
**vfox-mongod** is an open source project by [echocat](https://echocat.org). So if you want to make this project even better, you can contribute to this project on [Github](https://github.com/echocat/vfox-mongod) by [fork us](https://github.com/echocat/vfox-mongod/fork).
73
105
74
106
If you commit code to this project, you have to accept that this code will be released under the [license](#license) of this project.
0 commit comments