From 160a249dc6e74721a4eb98a0746c643ea4cd1b52 Mon Sep 17 00:00:00 2001 From: Alex Ling Date: Tue, 2 Jun 2020 15:26:38 +0000 Subject: [PATCH] Update CLI help message in README --- README.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e3a10c2..f768343 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ The official docker images are available on [Dockerhub](https://hub.docker.com/r ### Build from source -1. Make sure you have `crystal`, `shards` and `yarn` installed. You might also need to install the development headers for `libsqlite3` and `libyaml`. +1. Make sure you have `crystal`, `shards` and `yarn` installed. You might also need to install the development headers of some libraries. Please see the [Dockerfile](https://github.com/hkalexling/Mango/blob/master/Dockerfile) for the full list of dependencies 2. Clone the repository 3. `make && sudo make install` 4. Start Mango by running the command `mango` @@ -50,11 +50,21 @@ The official docker images are available on [Dockerhub](https://hub.docker.com/r ### CLI ``` -Mango e-manga server/reader. Version 0.4.0 + Mango - Manga Server and Web Reader. Version 0.4.0 - -v, --version Show version - -h, --help Show help - -c PATH, --config=PATH Path to the config file. Default is `~/.config/mango/config.yml` + Usage: + + mango [sub_command] [options] + + Options: + + -c PATH, --config=PATH Path to the config file [type:String] + -h, --help Show this help. + -v, --version Show version. + + Sub Commands: + + admin Run admin tools ``` ### Config