Add: help to readme

NobleMajo · Jun 9, 2024 · c898d95 · c898d95
1 parent a20023e
commit c898d95
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -16,6 +16,9 @@ Automatic hot-reloading webserver based on a file watcher, a websocket server, a
 
 - [hotweby](#hotweby)
 - [Getting started](#getting-started)
+  - [Global install](#global-install)
+  - [Show help](#show-help)
+  - [Run as webserver](#run-as-webserver)
 - [Contributing](#contributing)
 - [License](#license)
 - [Disclaimer](#disclaimer)
@@ -24,10 +27,30 @@ Automatic hot-reloading webserver based on a file watcher, a websocket server, a
 
 # Getting started
 
+## Global install
 ```sh
 npm i -g @noblemajo/hotweby
 ```
 
+## Show help
+```sh
+hotweby --help
+```
+
+```js
+Usage: hotweby [options]
+
+Automatic multiway hot-reloading webserver
+
+Options:
+  -V, --version               output the version number
+  -p, --port <number>         hot reload server port (env: SERVE_PORT)
+  -d, --dir <string>          target dir (default: ".", env: SERVE_PATH)
+  -i, --id-endpoint <string>  id endpoint (default: "/noblemajo-serve-id", env: SERVE_ID_ENDPOINT)
+  -h, --help                  display help for command
+```
+
+## Run as webserver
 ```sh
 hotweby -p 8080 -d html
 ```

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "hotweby",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "Automatic multiway hot-reloading webserver",
   "type": "module",
   "main": "dist/index.js",