From 733b974b257375464b283d8b06d072d98d9c5649 Mon Sep 17 00:00:00 2001
From: hub <code@hub.lol>
Date: Wed, 7 Sep 2022 23:12:21 +0200
Subject: [PATCH] update readme

---
 README.md | 65 +++++++++++++++++++++++++++++++++++++++----------------
 1 file changed, 46 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md
index a41a07c..b60641f 100644
--- a/README.md
+++ b/README.md
@@ -2,34 +2,61 @@
 
 [![Go Reference](https://pkg.go.dev/badge/github.com/nothub/mrpack-install.svg)](https://pkg.go.dev/github.com/nothub/mrpack-install)
 
-A cli application for installing Minecraft servers
-and [Modrinth](https://modrinth.com/) [modpacks](https://docs.modrinth.com/docs/modpacks/format_definition/).
+A cli application for installing Minecraft servers and [Modrinth](https://modrinth.com/) [modpacks](https://docs.modrinth.com/docs/modpacks/format_definition/).
 
 ---
 
-### Usage
-
+#### modpack deployment
 ```
-mrpack-install (<filepath> | <url> | <slug> [<version>] | <id> [<version>])
-mrpack-install server (vanilla | fabric | quilt | forge | paper | spigot)
-mrpack-install ping
+Deploys a Modrinth modpack including Minecraft server.
+
+Usage Examples:
+  mrpack-install downloads/cool-pack.mrpack
+  mrpack-install https://example.org/data/cool-pack.mrpack
+  mrpack-install hexmc-modpack --server-file server.jar
+  mrpack-install yK0ISmKn 1.0.0-1.18 --server-dir mcserver
+  mrpack-install communitypack9000 --host api.labrinth.example.org
+
+Usage:
+  mrpack-install (<filepath> | <url> | <slug> [<version>] | <id> [<version>]) [flags]
+  mrpack-install [command]
+
+Available Commands:
+  completion  Generate the autocompletion script for the specified shell
+  help        Help about any command
+  ping        Ping a Labrinth instance
+  server      Prepare a plain server environment
+  version     Print version infos
+
+Flags:
+      --download-threads int   Download threads (default 8)
+  -h, --help                   help for mrpack-install
+      --host string            Labrinth host (default "api.modrinth.com")
+      --proxy string           Use a proxy to download
+      --retry-times int        Number of retries when a download fails (default 3)
+      --server-dir string      Server directory path (default "mc")
+      --server-file string     Server jar file name
+
+Use "mrpack-install [command] --help" for more information about a command.
 ```
 
-### Examples
+---
 
+#### server deployment
 ```
-# install from file
-mrpack-install downloads/cool-pack.mrpack
+Download and configure one of several Minecraft server flavors.
 
-# install from url
-mrpack-install https://example.org/data/cool-pack.mrpack
+Usage Examples:
+  mrpack-install server fabric --server-dir fabric-srv
+  mrpack-install server paper --minecraft-version 1.18.2 --server-file srv.jar
 
-# install from api
-mrpack-install hexmc-modpack --server-file server.jar
-mrpack-install yK0ISmKn 1.0.0-1.18 --server-dir mcserver
-mrpack-install communitypack9000 --host api.labrinth.example.org
+Usage:
+  mrpack-install server (vanilla | fabric | quilt | forge | paper | spigot) [flags]
 
-# install bare server
-mrpack-install server fabric --server-dir fabricsrv
-mrpack-install server paper --minecraft-version 1.18.2 --server-file srv.jar
+Flags:
+      --flavor-version string      Flavor version (default "latest")
+  -h, --help                       help for server
+      --minecraft-version string   Minecraft version (default "latest")
+      --server-dir string          Server directory path (default "mc")
+      --server-file string         Server jar file name
 ```