From c0f6be93c7e5d71c066887cb41e97fda64fdf145 Mon Sep 17 00:00:00 2001 From: Kallum Jones Date: Tue, 9 Aug 2022 23:33:09 +0100 Subject: [PATCH] Add examples to readme --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ca98ab6..ad290ac 100644 --- a/README.md +++ b/README.md @@ -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