snxraven
/
mod-manager
mirror of https://git.bits.team/Bits/mod-manager.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add examples to readme

This commit is contained in:
Kallum Jones 2022-08-09 23:33:09 +01:00
parent ba89c554f1
commit c0f6be93c7
No known key found for this signature in database
GPG Key ID: D7F4589C4D7F81A9
1 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -14,7 +14,7 @@ A package manager-like CLI utility for managing installing, updating and migrati
## Demo
![A terminal window showing the usage of mod-managher](https://i.imgur.com/J8zw89M.gif)
![A terminal window showing the usage of mod-manager](https://i.imgur.com/J8zw89M.gif)
## Usage/Examples
@ -41,6 +41,26 @@ Commands:
help [command] display help for command
```
Initialising Mod Manager:
```
$ mod-manager init
? What Minecraft version is your server running? 1.19.1
Sucessfully initialised Mod Manager!
```
Installing a mod:
```
$ mod-manager install lithium
✔ Successfully installed Lithium
```
Listing installed mods:
```
$ mod-manager list
Name | Id | File Name | Version | Source | Essential | Dependencies
-------------------------------------------------------------------------------------------------------------
Lithium | gvQqBUqZ | lithium-fabric-mc1.19.2-0.8.3.jar | mc1.19.2-0.8.3 | Modrinth | false |
```
## Environment Variables